Skip to content
This repository was archived by the owner on Jul 10, 2025. It is now read-only.

Add CONTRIBUTING.md template #377

Merged
merged 1 commit into from
Apr 11, 2021
Merged
Changes from all 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
Copy link
Contributor Author

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.

Copy link
Contributor Author

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.

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