Welcome to Choerodon! When you want to make a contribution to Choerodon, the document elaborates how you can do.
Contributions are welcome and appreciation! Every little bit helps and credit will always be given.
When you are ready to contribution Please read Choerodon coding specification first.
You can contribute in many ways:
Report bugs through GitHub Issues
If you are reporting a bug, please include:
Your Browser and version. Any details about your local setup that might be helpful in troubleshooting. Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.
If you find any omissions or inaccuracies while browsing the documentation, leave feedback in Github Issues or modify it on the Fork website.
The best way to send feedback is to file an issue on GitHub.
If you are proposing a feature:
Explain in detail how it would work. Keep the scope as narrow as possible, to make it easier to implement. Remember that this is a volunteer-driven project, and that contributions are welcome
If you put forward a suggestion:
Elaborate your ideas and requirements in detail.
If you put forward a bug:
Describe the problems you encountered, the operating environment and your own ideas in detail.
Go to Choerodon, click fork button. 2. Clone fork to local storage
git clone https://github.com/$user/choerodon.git
Update local branch of master and create new branch.
git pull origin master git checkout -b myfeature
Modify on the branch of myfeature.
Testing is the responsibility of all contributors.
Please write the unit test case.
Before submitting your code, please update the latest code and resolve conflict locally.
git fetch & git rebase
Submit your locally modified code.
git commit -m "[IMP] summit"
[IMP] Improve the function
[FIX] Fix the bug
[ADD] Add the funtion
[DEL] Delete the document
Push code to your remote repository.
Create a [merge request] on Github(https://help.github.com/articles/about-pull-requests/), wait to verify.
Completing the following points will help your submission to get better comments:
Reviewers need to observe the following guidelines:
Project maintainers have the right and responsibility to delete, edit or reject comments, submissions, codes, questions, and other contributions that do not conform to the revised guidelines. The project maintainers promise to treat all adherence to the guidelines fairly and consistently.People who do not follow the code of conduct may be permanently removed from the project team.