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.

Sign up for GitHub

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 sig project recommendations for each newly created paddlepaddle sig project. #2

Merged
merged 1 commit into from
Oct 28, 2020
Merged

Add sig project recommendations for each newly created paddlepaddle sig project. #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions TOC/SIG_PROJECT_RECOMMENDATIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Recommended Practices for PaddlePaddle SIG Project

Here are some recommended practices to increase PaddlePaddle SIG project's visibility.

* Document your project governance and make it available in the project repository.

* Setting up issue templates and pull request templates helps you customize and standardize the information that you'd like contributors to include when they open questions and pull requests in the repository.

* Ensure that each repurchase contains a license file.

* Provide documentation on release methodology, cadence, criteria, etc.

* Add a README file to your repository, welcome new community members to the project, and explain why the project is useful and how to get started.

* Add a CONTRIBUTING file to your repository to show other developers and your user community how to contribute to the project. At a higher level, the document will explain what types of contributions are required and how the process works.

* Add the OWNERS file to define the person or team responsible for the code in the repository.

* Add a CODE_OF_CONDUCT file, which sets the basic rules of behavior related to participants and helps to create a friendly environment. Although not every project has a CODE_OF_CONDUCT file, but its presence indicates that this is a popular project and defines criteria for interaction with the project community.