Welcome to pole-group/conf! This document is a guideline about how to contribute to pole-group/conf.
If you find something incorrect or missing, please leave comments / suggestions.
Please make sure to read and observe our Code of Conduct.
If you find a typo in document, find a bug in code, or want new features, or want to give suggestions, you can open an issue on GitHub to report it.
If you just want to contribute directly you can choose the issue below.
-
Contribution Welcome: Heavily needed issue, but currently short of hand.
-
good first issue: Good for newcomers, new comer can pickup one for warm-up.
Please note that any PR must be associated with a valid issue. Otherwise the PR will be rejected.
Now if you want to contribute, please create a new pull request.
We use the develop
branch as the development branch, which indicates that this is a unstable branch.
Further more, our branching model complies to https://nvie.com/posts/a-successful-git-branching-model/. We strongly suggest new comers walk through the above article before creating PR.
Now, if you are ready to create PR, here is the workflow for contributors:
-
Fork to your own
-
Clone fork to local repository
-
Create a new branch and work on it
-
Keep your branch in sync
-
Commit your changes (make sure your commit message concise)
-
Push your commits to your forked repository
-
Create a pull request to develop branch.
When creating pull request:
-
Please follow the pull request template.
-
Please create the request to develop branch.
-
Please make sure the PR has a corresponding issue.
-
If your PR contains large changes, e.g. component refactor or new components, please write detailed documents about its design and usage.
-
Note that a single PR should not be too large. If heavy changes are required, it's better to separate the changes to a few individual PRs.
-
After creating a PR, one or more reviewers will be assigned to the pull request.
-
Before merging a PR, squash any fix review feedback, typo, merged, and rebased sorts of commits. The final commit message should be clear and concise.
If your PR contains large changes, e.g. component refactor or new components, please write detailed documents about its design and usage.
Committers will rotate reviewing the code to make sure all the PR will be reviewed timely and by at least one committer before merge. If we aren't doing our job (sometimes we drop things). And as always, we welcome volunteers for code review.
Some principles:
-
Readability - Important code should be well-documented. API should have Javadoc. Code style should be complied with the existing one.
-
Elegance: New functions, classes or components should be well designed.
-
Testability - 80% of the new code should be covered by unit test cases.