-
Notifications
You must be signed in to change notification settings - Fork 580
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a standard CONTRIBUTING.md template #384
Open
bhack
wants to merge
5
commits into
tensorflow:master
Choose a base branch
from
bhack:community_template
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
407d322
Add a standard readme template
bhack 51b3e1c
Merge branch 'master' of https://github.com/tensorflow/community
bhack 49df0b6
Revert "Revert "Add CONTRIBUTING.md template""
bhack 15bec1e
Delete SIG-readme-template.md
bhack 1e43198
Fix typo
bhack 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 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 |
This file contains 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,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 |
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.
I would like to suggest we consider adding this as a separate file (CALL_FOR_MAINTAINERS.md?) due to the importance of the role.
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.
Good, we could put here just a like to an external markdown.
I don't know if we could open a new thread later about standardizing a little bit the
CALL_FOR_MAINTAINERS
process/roles.E.g. Debian has historically a quite regulated Maintainer process. This is just to make a reference example but it is too complex for us.
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.
/cc I think that also @mihaimaruseac could be interested in the Codeowner/Maintainer status and process.