From 407d322f2e4a67b21845a5176e1e355a993c5d16 Mon Sep 17 00:00:00 2001 From: bhack Date: Mon, 29 Mar 2021 20:02:29 +0200 Subject: [PATCH 1/4] Add a standard readme template --- governance/SIG-readme-template.md | 47 +++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 governance/SIG-readme-template.md diff --git a/governance/SIG-readme-template.md b/governance/SIG-readme-template.md new file mode 100644 index 000000000..1e55b16d5 --- /dev/null +++ b/governance/SIG-readme-template.md @@ -0,0 +1,47 @@ + +# :framed_picture [SIG Logo](https://github.com/tensorflow/community/tree/master/sigs/logos) + +## SIG presentation +A general short description of the Repository/SIG. + +## Badges section +Add badges for you repostiroy (pypy, python, gitter, api etc.) + +CI/Buid specifc badges + +## Project/Repository structure +A repository overiew with a short description of its tree/modularity + +## Tensorflow compatibility Matrix +Repository releases compatibility with TF and Python version or (other languages, cuda, etc.) + +## Release policy +Describe the release policy: + +E.g. A release each Tensorflow release, multiple releases between two Tensorflow releases, etc. + +## Installation +Quick instruction on how to install the packaged version of the repository + +## Docker +How to start to use the library inside a Docker container. +If the specific repo doesn't maintain its own Docker image we could route the user to install the package inside the Tensorflow official Docker container + +## Build from source +Pointer to a specific CONTRIBUTING.md section + +## Example +A very minimal inline primer just to quiclky expose the library + +## DOCS/API +Link to the Tensorflow web site + +## Contributing +Link to the CONTRIBUTING.md + +## Support/community +Mailing list/Forum +Gitter + +## Extra info +Pleae add any extra info or references to others Markdown files in the specific repo \ No newline at end of file From 49df0b64c028074cb499759b702108b874c850b2 Mon Sep 17 00:00:00 2001 From: bhack Date: Wed, 21 Apr 2021 20:24:51 +0200 Subject: [PATCH 2/4] Revert "Revert "Add CONTRIBUTING.md template"" This reverts commit 4ae7e6f278256b26d44f21cb070823a9bcb9e76e. --- governance/SIG-contributing-template.md | 50 +++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 governance/SIG-contributing-template.md diff --git a/governance/SIG-contributing-template.md b/governance/SIG-contributing-template.md new file mode 100644 index 000000000..db12ab054 --- /dev/null +++ b/governance/SIG-contributing-template.md @@ -0,0 +1,50 @@ +## We welcome contribution +Describe what kind of issues a new contributor could pick. + +[TODO:] A list of standardized labels “good first issue”?, “contribution welcome”?, etc. + +## Contributor checklist +* Comment on an existing ticket or open a new one before coding any PR +* Wait for a specific approval reply from mantainers and an `approved-for-PR` label +* Read and Sign the CLA +* Follow Tensorflow coding style +* Follow extra repository specific code style +* Write and execute tests +* Lint your code + +## Environment setup +How to checkout the code and mount the volume inside a container + + +## Build from source +How to build the code from source inside a container + +## Codestyle +Link to Google style guides and any other specific code style +Linting info and how to configure pre-commit hooks + +## IDE +Any available info for working with specific IDE +How to use [Codespaces/Devcontainers](https://github.com/microsoft/vscode-dev-containers) if supported + +## DOCS +To contribute to the documentation please follow [DOCS.md] + +## TESTS +How to write and execute tests (bazel, pytest, etc.) or a link to a specific [TEST.md] + +## DEBUG +How to debug your code + +## CI +Quickly describe your CI + +## CODEOWNERS +Describe how codeownership and maintainership in the repo: +* How to be a Codeowner +* How to be a Maintainer +* MIA (Missing in Action) handling +* Orphaned modules/features handling + +## Extra info +Pleae add any extra info or references to others Markdown files in the specific repo \ No newline at end of file From 15bec1e5e72e0fb3c4696ce413cef9bb56efc729 Mon Sep 17 00:00:00 2001 From: bhack Date: Mon, 6 Sep 2021 21:37:54 +0200 Subject: [PATCH 3/4] Delete SIG-readme-template.md --- governance/SIG-readme-template.md | 47 ------------------------------- 1 file changed, 47 deletions(-) delete mode 100644 governance/SIG-readme-template.md diff --git a/governance/SIG-readme-template.md b/governance/SIG-readme-template.md deleted file mode 100644 index 1e55b16d5..000000000 --- a/governance/SIG-readme-template.md +++ /dev/null @@ -1,47 +0,0 @@ - -# :framed_picture [SIG Logo](https://github.com/tensorflow/community/tree/master/sigs/logos) - -## SIG presentation -A general short description of the Repository/SIG. - -## Badges section -Add badges for you repostiroy (pypy, python, gitter, api etc.) - -CI/Buid specifc badges - -## Project/Repository structure -A repository overiew with a short description of its tree/modularity - -## Tensorflow compatibility Matrix -Repository releases compatibility with TF and Python version or (other languages, cuda, etc.) - -## Release policy -Describe the release policy: - -E.g. A release each Tensorflow release, multiple releases between two Tensorflow releases, etc. - -## Installation -Quick instruction on how to install the packaged version of the repository - -## Docker -How to start to use the library inside a Docker container. -If the specific repo doesn't maintain its own Docker image we could route the user to install the package inside the Tensorflow official Docker container - -## Build from source -Pointer to a specific CONTRIBUTING.md section - -## Example -A very minimal inline primer just to quiclky expose the library - -## DOCS/API -Link to the Tensorflow web site - -## Contributing -Link to the CONTRIBUTING.md - -## Support/community -Mailing list/Forum -Gitter - -## Extra info -Pleae add any extra info or references to others Markdown files in the specific repo \ No newline at end of file From 1e4319862ddb2abc6ccbdda2a54c8c3a09b6005d Mon Sep 17 00:00:00 2001 From: bhack Date: Tue, 1 Feb 2022 01:30:40 +0100 Subject: [PATCH 4/4] Fix typo --- governance/SIG-contributing-template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/governance/SIG-contributing-template.md b/governance/SIG-contributing-template.md index db12ab054..9fd3da79b 100644 --- a/governance/SIG-contributing-template.md +++ b/governance/SIG-contributing-template.md @@ -5,7 +5,7 @@ Describe what kind of issues a new contributor could pick. ## Contributor checklist * Comment on an existing ticket or open a new one before coding any PR -* Wait for a specific approval reply from mantainers and an `approved-for-PR` label +* Wait for a specific approval reply from maintainers and an `approved-for-PR` label * Read and Sign the CLA * Follow Tensorflow coding style * Follow extra repository specific code style @@ -47,4 +47,4 @@ Describe how codeownership and maintainership in the repo: * Orphaned modules/features handling ## Extra info -Pleae add any extra info or references to others Markdown files in the specific repo \ No newline at end of file +Please add any extra info or references to others Markdown files in the specific repo