Home / GitHub Page

Troubleshooting FAQ and collecting topic for contributing to Joplin codebase

this is a living topic what shall collect and describe nicely all traps and hurdles when trying to contribute to codebase of Joplin.

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.

development environment


build


contribute


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 git@github.com:<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-number and closes, if your PR would fix an issue.

  • Use git diff or git difftool to see exactly what’s changed and remove any change that’s not relevant to your issue. Consider using git add -p to add only the relevant changes.

app architecture


3 Likes

@PackElend, I’ve noticed that several applicants commit changes unrelated to their PR. It’s been a time sink in some PR as we have to remind them over and over again to remove these changes.

So I think we should suggest they check their changes carefully before committing them. Something like:

Before committing your changes, make sure you check that what you are going to commit. For example, some editors reformat the code when saving, or you might have added test code that shouldn’t end up in the PR.

Use git diff or git difftool to see exactly what’s changed and remove any change that’s not relevant to your issue. Consider using git add -p to add only the relevant changes.

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.

2 Likes

agree will update the quick start guide
done in in the live blog and here

Where to install a new dependency that will be used by all the platform apps?

1 Like