Creating a Pull Request
We use a standard fork-and-branch workflow. See https://blog.scottlowe.org/2015/01/27/using-fork-branch-git-workflow/ for a good introduction.
Here are some tips and tricks to make the process of contributing as smooth as possible.
- Adhere to the guidelines described in this folder.
- Discuss your contribution before and while you are working on it. Create an issue to discuss your general ideas and questions. For more detailed and longer conversations, you could also make use of Isabelle’s Zulip.
/<path to isabelle>/bin/isabelle build -vD .to check if your project compiles before sending a PR
- Create a pull request from a feature branch on your personal fork, as explained in the link above, or from a branch of the main repository if you have commit access.
- If you have made a lot of changes/additions, make many PRs containing small, self-contained pieces. This helps you get feedback as you go along, and it is much easier to review. This is especially important for new contributors.
- Answer the following three questions in your PR:
- What: What is this PR about?
- Why: Why is this PR useful/what is the problem you solve?
- How: How did you create the feature/solve the problem?
- Check the code-review checklist below.
- As for commits, bugs closed by the PR should be listed on a separate line in the footer prefixed with “Closes”.
When creating or reviewing a pull request, make sure you can tick all boxes of the following checklist:
Check: * [ ] coding style * [ ] documentation * [ ] for tactics: * [ ] tests * [ ] efficiency (make sure at least it's not outrageously inefficient) * [ ] it fits the overall library design