Contribution guidelines

Do you want to contribute to the project? Great! Here's what you can do to make the process as smooth and efficient as possible.

1. Create an issue describing the problem you're having or the feature you need. Try to be clear, concise and descriptive. If you know which project the issue is related to, add the issue to that project. Otherwise, you can ask a maintainer for advice.
2. Unless the issue you're having is trivial, you should contact a maintainer to discuss possible solutions before you begin working on it. In the issue created in step 1, make a note that you have discussed the issue with a maintainer and what you agreed upon. In some cases, the entire discussion will take place in the issue, in which case everything is already documented sufficiently.
3. Solve the problem. Unless there is a good reason not to, you should follow applicable guidelines and conventions, for example the Principles.
4. Rebase your change so that it is ahead of the current master.
5. Make sure that your change works by running all applicable tests.
6. Make a PR and notify a maintainer.

That's it! If there are issues with your change, the maintainer will contact you. If the current master has moved and it conflicts with your PR, you might be asked to rebase it again. You're responsible for resolving any conflicts with master until your PR has been merged.

Why do I need to contact a maintainer? Shouldn't the Github notifications take care of this?

In theory, yes. However, the current maintainer is notorious for not noticing Github notifications ... ever. So, for the time being, you are highly recommended to contact the maintainer separately whenever you need assistance.