Skip to content

T
tic
Commit 7fd7db0f by Tianqi Chen Committed by GitHub
Options

[DOCS] Code quality comment (#1069)

parent c29205da
Showing with 10 additions and 3 deletions
CONTRIBUTORS.md
...@@ -6,6 +6,9 @@ The package is developed and used by the community. ...@@ -6,6 +6,9 @@ The package is developed and used by the community.
We actively seek committers that come from community contributors who: We actively seek committers that come from community contributors who:
- Made substantial contributions to the project. - Made substantial contributions to the project.
- All forms of contributions are valued (see detail in next section). - All forms of contributions are valued (see detail in next section).
- Maintain quality standards in contributions
- e.g. consistently made contributions without requiring extensive
rewrites prior to being merged.
- Willing to spend time on maintaining and lead the project. - Willing to spend time on maintaining and lead the project.
Contributions Contributions
...@@ -23,10 +26,10 @@ list of contributions that are welcomed ...@@ -23,10 +26,10 @@ list of contributions that are welcomed
- Test cases to make the codebase more robust - Test cases to make the codebase more robust
- Tutorials, blog posts, talks that promote the project. - Tutorials, blog posts, talks that promote the project.
How to Contribute How to Contribute
----------------- -----------------
See [Contributor guide](docs/how_to/contribute.md) on how to contribute. See [Contributor guide](docs/how_to/contribute.md) on tips for contributions.
Committers Committers
---------- ----------
......
docs/how_to/contribute.md
...@@ -12,7 +12,7 @@ Everyone is more than welcome to contribute. It is a way to make the project bet ...@@ -12,7 +12,7 @@ Everyone is more than welcome to contribute. It is a way to make the project bet
- [How to resolve conflict with master](#how-to-resolve-conflict-with-master) - [How to resolve conflict with master](#how-to-resolve-conflict-with-master)
- [How to combine multiple commits into one](#how-to-combine-multiple-commits-into-one) - [How to combine multiple commits into one](#how-to-combine-multiple-commits-into-one)
- [What is the consequence of force push](#what-is-the-consequence-of-force-push) - [What is the consequence of force push](#what-is-the-consequence-of-force-push)
* [Document](#document) * [Code Quality](#code-quality)
* [Testcases](#testcases) * [Testcases](#testcases)
* [Core Library](#core-library) * [Core Library](#core-library)
* [Python Package](#python-package) * [Python Package](#python-package)
...@@ -85,6 +85,10 @@ git push --force ...@@ -85,6 +85,10 @@ git push --force
The previous two tips requires force push, this is because we altered the path of the commits. The previous two tips requires force push, this is because we altered the path of the commits.
It is fine to force push to your own fork, as long as the commits changed are only yours. It is fine to force push to your own fork, as long as the commits changed are only yours.
## Code Quality
Each patch we made can also become a potential technical debt in the future. We value high-quality code that can be understood and maintained by the community. We encourage contributors to submit coverage test cases, write or contribute comments on their code to explain the logic and provide reviews feedbacks to hold these standards.
## Testcases ## Testcases
- All the testcases are in tests - All the testcases are in tests
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment