For the time being anyone is welcome to edit this wiki.
If you feel that there is something that should be mentioned here, just reply in this topic and quote (discourse allows to quote across different topic) or reference to it, we will take from there.
basics about the PR
as there are not that many reviewers around here keep your PR clean to safe us time, you should be familiar with Use
git diff or
git difftool and know why to use them.
Moreover, some editors reformat the code when saving, or you might have added test code that shouldn’t end up in the PR.
Pull requests that include changes unrelated to your issue will not be merged . Moreover it does not reflect well on your work when mentors have to remind you to clean up your pull request.
Effectively using Github
After forking Joplin, clone the repository to build it locally
git clone firstname.lastname@example.org:<your-userid>/joplin.git
Then add another remote to pull changes from upstream.
git remote add upstream https://github.com/laurent22/joplin.git
Github does not automatically sync your forked repository with the main Joplin repo, you need to do it manually here’s how to.
There is another niche way of doing the same automatically too.
When you are making a pull request make sure you do not commit changes to your master branch (master branch of the forked-repo should be the one which is constantly synced with the main Joplin repository), create a new branch, push changes to it, and create a Pull-Request from that branch, it will save you a lot of time, in the case, your PR is not accepted you don’t need to reconfigure master branch. This is a really good video which will refresh your concepts about branches.
Use Github-keywords like
fixes #issue-numberand closes, if your PR would fix an issue.
git difftoolto see exactly what’s changed and remove any change that’s not relevant to your issue. Consider using
git add -pto add only the relevant changes.