self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2024-11-27 08:21:03 +02:00
Code Issues Releases Activity
e6aa002758
joplin/CONTRIBUTING.md
Laurent Cozic 01a3285636 Updated doc
2019-01-25 17:14:17 +00:00

2.4 KiB
Raw Blame History

IMPORTANT: At the moment pull requests for new features are no longer being accepted. More info there: https://github.com/laurent22/joplin/issues/1112

User support

For general discussion about Joplin, user support, software development questions, and to discuss new features, please go to the Joplin Forum. It is possible to login with your GitHub account.

Reporting a bug

Please check first that it has not already been reported. Also consider enabling debug mode before reporting the issue so that you can provide as much details as possible to help fix it.

If possible, please provide a screenshot. A screenshot showing the problem is often more useful than a paragraph describing it as it can make it immediately clear what the issue is.

Feature requests

Again, please check that it has not already been requested. If it has, simply up-vote the issue - the ones with the most up-votes are likely to be implemented. "+1" comments are not tracked.

Creating a pull request

  • If you want to add a new feature, consider asking about it before implementing it or checking existing discussions to make sure it is within the scope of the project. That scope, due to limited resources, might be narrower than you think. As a rule of thumb if your change is likely to involve more than 50 lines of code, you should discuss it in the forum, just so that you don't waste your time implementing something that might not be accepted.

  • Bug fixes have a very high change of being accepted.

  • A pull request that is relevant to the current roadmap has a very high change of being accepted.

Building the apps is relatively easy - please see the build instructions for more details.

Coding style

There are only two rules, but not following them means the pull request will not be accepted (it can be accepted once the issues are fixed):

  • Please use tabs, NOT spaces.
  • Please do not add or remove optional characters, such as spaces or colons. Please setup your editor so that it only changes what you are working on and is not making automated changes elsewhere. The reason for this is that small white space changes make diff hard to read and can cause needless conflicts.