You can report a bug, submit a new function enhancement suggestion, or submit a pull request directly.
Submit an Issue
- Before submitting an issue, please go through a comprehensive search to make sure the problem cannot be solved just by searching.
- Check the Issue List to make sure the problem is not repeated.
- Create a new issue and choose the type of issue.
- Define the issue with a clear and descriptive title.
- Fill in necessary information according to the template.
- Choose a label after issue created, for example: bug，enhancement，discussion.
- Please pay attention for your issue, you may need provide more information during discussion.
Fork Soul repo
- Fork a
Soulrepo to your own repo to work, then setting upstream.
git remote add upstream https://github.com/dromara/soul.git
- Please choose the issue to be edited. If it is a new issue discovered or a new function enhancement to offer, please create an issue and set the right label for it.
- After choosing the relevant issue, please reply with a deadline to indicate that you are working on it.
- Switch to forked master branch, pull codes from upstream, then create a new branch.
git checkout master git pull upstream master git checkout -b issueNo
Notice ：We will merge PR using squash, commit log will be different form upstream if you use old branch.
- Please obey the Code of Conduct during the process of development and finish the check before submitting the pull request.
- push code to your fork repo.
git add modified-file-names git commit -m 'commit log' git push origin issueNo
Submit Pull Request
- Send a pull request to the master branch.
- The mentor will do code review before discussing some details (including the design, the implementation and the performance) with you. The request will be merged into the branch of current development version after the edit is well enough.
- At last, congratulate to be an official contributor of Soul.
- You can delete the remote branch (origin/issueNo) and the local branch (issueNo) associated with the remote branch (origin/issueNo) after the mentor merged the pull request into the master branch of Soul.
git checkout master git branch -d issueNo git push origin --delete issueNo
Notice: Please note that in order to show your id in the contributor list, don’t forget the configurations below:
git config --global user.name "username" git config --global user.email "email@example.com"
- After each Pull Request (PR), you need to execute the following operations, otherwise, the previous PR commit records will be mixed with this PR commit records. The specific operation process is as follows:
git checkout master git fetch upstream git reset --hard upstream/master git push -f