Re-organize contributor's guide (#4659)
* Reorganize contributor's doc * Address comments from @trivialfis * Address @sriramch's comment: include ABI compatibility guarantee * Address @rongou's comment * Postpone ABI compatibility guarantee for now
This commit is contained in:
committed by
GitHub
parent
2973416f2e
commit
9975c533c7
@@ -1,14 +1,28 @@
|
||||
###################
|
||||
#####################
|
||||
Contribute to XGBoost
|
||||
###################
|
||||
#####################
|
||||
|
||||
XGBoost has been developed by community members. Everyone is welcome to contribute. We value all forms of contributions, including, but not limited to:
|
||||
|
||||
********
|
||||
Contents
|
||||
********
|
||||
* Code reviews for pull requests
|
||||
* Documentation and usage examples
|
||||
* Community participation in forums and issues
|
||||
* Code readability and developer guide
|
||||
|
||||
- We welcome contributions that add code comments to improve readability.
|
||||
- We also welcome contributions to docs to explain the design choices of the XGBoost internals.
|
||||
|
||||
* Test cases to make the codebase more robust.
|
||||
* Tutorials, blog posts, talks that promote the project.
|
||||
|
||||
Here are guidelines for contributing to various aspect of the XGBoost project:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
XGBoost Community Guidance <community.rst>
|
||||
Release Policy <release.rst>
|
||||
Community Guideline <community>
|
||||
coding_guide
|
||||
unit_tests
|
||||
Docs and Examples <docs>
|
||||
git_guide
|
||||
release
|
||||
|
||||
Reference in New Issue
Block a user