forked from tronprotocol/java-tron
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
863 changed files
with
44,290 additions
and
19,188 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,83 @@ | ||
| # Contributing to java-tron | ||
|
|
||
| java-tron is an open source project. | ||
|
|
||
| It is the work of contributors. We appreciate your help! | ||
|
|
||
| Here are instructions to get you started. They are not perfect, so | ||
| please let us know if anything feels wrong or incomplete. | ||
|
|
||
| ## Contribution guidelines | ||
|
|
||
| ### Pull requests | ||
|
|
||
| First of all, java-tron follows [gitflow workflow]( | ||
| https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). | ||
| Please open pull requests to the **develop** branch. Once approved, | ||
| we will close the pull request and merge into master branch. | ||
|
|
||
| We are always happy to receive pull requests, and do our best to | ||
| review them as fast as possible. Not sure if that typo is worth a pull | ||
| request? Do it! We would appreciate it. | ||
|
|
||
| If your pull request is not accepted on the first try, don't be | ||
| discouraged as it can be a possible oversight. Please explain your code as | ||
| detailed as possible to make it easier for us to understand. | ||
|
|
||
| ### Create issues | ||
|
|
||
| Any significant improvement should be documented as [a GitHub | ||
| issue](https://github.com/tronprotocol/java-tron/issues) before anyone | ||
| starts working on it. | ||
|
|
||
| When filing an issue, make sure to answer these three questions: | ||
|
|
||
| - What did you do? | ||
| - What did you expect to see? | ||
| - What did you see instead? | ||
|
|
||
| ### Please check existing issues and docs first! | ||
|
|
||
| Please take a moment to check that your bug report or improvement proposal | ||
| doesn't already exist. If it does, please add a quick "+1" or "I have this problem too". | ||
| This will help prioritize the most common problems and requests. | ||
| # Contributing to java-tron | ||
|
|
||
| java-tron is an open source project. | ||
|
|
||
| It is the work of contributors. We appreciate your help! | ||
|
|
||
| Here are instructions to get you started. They are not perfect, so | ||
| please let us know if anything feels wrong or incomplete. | ||
|
|
||
| ## Contribution guidelines | ||
| First of all, java-tron follows GitFlow, the branches description in the java-tron project are listed as follow: | ||
|
|
||
| ``master`` branch: | ||
| This branch contains the latest code released to the production environment. It can only be merged, and can not be modified directly in this branch. | ||
|
|
||
| ``develop`` branch: | ||
| This branch is the main development branch. It contains the complete code that is going to release. It can only be merged, and can not be modified directly in this branch. | ||
|
|
||
| ``feature`` branch: | ||
| This branch is used to develop new features. It is created based on ``develop`` branch. Once the development is finished, it should be merged into ``develop`` branch, and then delete the branch. | ||
|
|
||
| ``release`` branch: | ||
| This is the branch that is going to be released. It is created based on ``develop`` branch. In this branch, small fix and modification of final version of metadata is allowed. When the code is released, this branch should be merged into ``master`` branch(tag needed) and ``develop`` branch. The final test before release uses this branch. | ||
|
|
||
| ``hotfix`` branch: | ||
| This branch is used to fix a bug when an online bug is found. It is created based on ``master`` branch. When bug fix is done, it should be merged into ``master`` branch(as a new release) and ``develop`` and then delete the branch. branch. | ||
|
|
||
| ### Pull requests | ||
|
|
||
| If you'd like to contribute to java-tron, you should follow the steps below: | ||
| - **Fork** a repository from **tronprotocol/java-tron** allows you to freely experiment with changes without affecting the original project | ||
| - **Fix** some code and **Commit** your modified code. | ||
| - **Send** a Pull Request（PR）for the maintainers to review and merge into the main code base. | ||
| *notice*：When you create a new PR，please choose the **tronprotocol/java-tron** as the base repository and choose **your fork/java-tron** as the head repository. | ||
| And you must choose **develop** as the base repository branch, which means we will merge the PR into our **develop** branch when reviewed and approved. | ||
| Additionally, if you are writing a new feature, please ensure you add appropriate test cases under ``/src/test``. | ||
|
|
||
| After the PR is checked by our Sonar check procedure and Travis CI continuous-integration check procedure automaticly, | ||
| we maintainers will review the code changed and give some advices for modifying if necessary.Once approved, | ||
| we will close the PR and merge into the protocol/java-tron's develop branch. | ||
|
|
||
| We are always happy to receive pull requests, and do our best to | ||
| review them as fast as possible. Not sure if that typo is worth a pull | ||
| request? Do it! We would appreciate it. | ||
|
|
||
| If your pull request is not accepted on the first try, don't be | ||
| discouraged as it can be a possible oversight. Please explain your code as | ||
| detailed as possible to make it easier for us to understand. | ||
|
|
||
| Please make sure your contributions adhere to our coding guidelines: | ||
|
|
||
| - Code must be documented adhering to the [Google Style](https://google.github.io/styleguide/javaguide.html) | ||
| - Code must pass Sonar detection. | ||
| - Pull requests need to be based on and opened against the develop branch. | ||
| - Commit messages should be started with verb, and the first letter should be a lowercase.The length of commit message | ||
| must be limited in 50 words. | ||
| ### Create issues | ||
|
|
||
| Any significant improvement should be documented as [a GitHub | ||
| issue](https://github.com/tronprotocol/java-tron/issues) before anyone | ||
| starts working on it. | ||
|
|
||
| When filing an issue, make sure to answer these three questions: | ||
|
|
||
| - What did you do? | ||
| - What did you expect to see? | ||
| - What did you see instead? | ||
|
|
||
| ### Please check existing issues and docs first! | ||
|
|
||
| Please take a moment to check that your bug report or improvement proposal | ||
| doesn't already exist. If it does, please add a quick "+1" or "I have this problem too". | ||
| This will help prioritize the most common problems and requests. | ||
|
|
||
| ## Community Developers Incentives Programme | ||
|
|
||
| Bonus point applies in TRON incentives programme. Developers can earn points by contributing to TRON. | ||
|
|
||
| You can find your points ranking at [Tronscan](https://tronscan.org/#/developersreward). | ||
|
|
||
| The Top 5 scored developers (for every month, quarter and year) can win a cash reward. | ||
|
|
||
| For more details, please visit [Incentives Policy](https://tronprotocol.github.io/documentation-en/developers/incentives/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.