This repository was archived by the owner on Jul 10, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 577
Add CONTRIBUTING.md template #377
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It could be great if we could standardize and automatically monitor the codeowners/mentors availability.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could take some idea from the Addons proxy maintainership also if some of these theoretic best practices are not applied.