A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report and feature propose, and will thank you for it!
When reporting issues, refer to this format:
See more about ISSUE_TEMPLATE.
If you are a beginner and expect this project as the gate to open source world, this tutorial is one of the best choices for you. Just follow the guidance and you will find the pleasure to becoming a contributor.
Before making modifications of this project, you need to make sure that this project have been forked to your own repository. It means that there will be parallel development between this repo and your own repo, so be careful to avoid the inconsistency between these two repos.
If you want to download the code to the local machine,
git is the best way:
git clone https://your_repo_url/projectname.git
To avoid inconsistency between multiple branches, we SUGGEST checking out to a new branch:
git checkout -b new_branch_name origin/master
Then you can change the code arbitrarily.
After updating the code, you should push the update in the formal way:
git add . git status (Check the update status) git commit -m "Your commit title" git commit --amend (Add the concrete description of your commit) git push origin new_branch_name
In the last step, your need to pull a compare request between your new branch and development branch. After finishing the pull request, the CI will be automatically set up for building test.
When submitting pull requests, refer to this format:
See more about PULL_REQUEST_TEMPLATE.
TO BE DEFINED