-
Notifications
You must be signed in to change notification settings - Fork 664
Writing a Good Pull Request
Pull requests are like life blood of a repository, they keep everything healthy and moving. Consequently, if the flow of PRs gets stopped up that can be bad. This page details how to create a PR that is complete and easy to review, which makes it more likely that your PR will get merged!
What follows are a few steps you can take to make sure you create the best PR possible.
- Communicate
- Get Set Up
- Keep it Small
- Keep it Clean
- Test your Change
- Communicate (pt2)
Before you jump in and start writing code, it's helpful to communicate with the core team so they know what you're interested in.
If there is an issue you are interested in, which is in your jurisdiction and has the correct status, the communication is simple! Just put a comment on the issue saying you're going to start to work on it. This makes sure that we don't have multiple people working on the same thing.
Alternatively, if you have an idea which is not covered by an issue, please write one up before you begin work. This gives the team a chance to discuss how best to build out the change before you start building. So it will save you work in the long run.
If you've contributed to a GitHub repository before, the process for getting set up will be familiar to you. It's important to note that in this repo we work off of the master branch. This is different than the Blockly core repo, where work is done off of develop.
If you haven't contributed to a GitHub project before, you can use these steps to get started: