Skip to content
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
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions governance/SIG-contributing-template.md
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

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.

Copy link
Contributor Author

@bhack bhack Jun 4, 2021

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.

Copy link
Contributor Author

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.

* 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
47 changes: 47 additions & 0 deletions governance/SIG-readme-template.md
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