|
| 1 | +## We welcome contribution |
| 2 | +Describe what kind of issues a new contributor could pick. |
| 3 | + |
| 4 | +[TODO:] A list of standardized labels “good first issue”?, “contribution welcome”?, etc. |
| 5 | + |
| 6 | +## Contributor checklist |
| 7 | +* Comment on an existing ticket or open a new one before coding any PR |
| 8 | +* Wait for a specific approval reply from mantainers and an `approved-for-PR` label |
| 9 | +* Read and Sign the CLA |
| 10 | +* Follow Tensorflow coding style |
| 11 | +* Follow extra repository specific code style |
| 12 | +* Write and execute tests |
| 13 | +* Lint your code |
| 14 | + |
| 15 | +## Environment setup |
| 16 | +How to checkout the code and mount the volume inside a container |
| 17 | + |
| 18 | + |
| 19 | +## Build from source |
| 20 | +How to build the code from source inside a container |
| 21 | + |
| 22 | +## Codestyle |
| 23 | +Link to Google style guides and any other specific code style |
| 24 | +Linting info and how to configure pre-commit hooks |
| 25 | + |
| 26 | +## IDE |
| 27 | +Any available info for working with specific IDE |
| 28 | +How to use [Codespaces/Devcontainers](https://github.com/microsoft/vscode-dev-containers) if supported |
| 29 | + |
| 30 | +## DOCS |
| 31 | +To contribute to the documentation please follow [DOCS.md] |
| 32 | + |
| 33 | +## TESTS |
| 34 | +How to write and execute tests (bazel, pytest, etc.) or a link to a specific [TEST.md] |
| 35 | + |
| 36 | +## DEBUG |
| 37 | +How to debug your code |
| 38 | + |
| 39 | +## CI |
| 40 | +Quickly describe your CI |
| 41 | + |
| 42 | +## CODEOWNERS |
| 43 | +Describe how codeownership and maintainership in the repo: |
| 44 | +* How to be a Codeowner |
| 45 | +* How to be a Maintainer |
| 46 | +* MIA (Missing in Action) handling |
| 47 | +* Orphaned modules/features handling |
| 48 | + |
| 49 | +## Extra info |
| 50 | +Pleae add any extra info or references to others Markdown files in the specific repo |
0 commit comments