Pull requests let you tell others about changes you’ve pushed to a GitHub repository. Once a pull request is sent, interested parties can review the set of changes & discuss potential modifications. The accuracy of PRs enables teams to make the necessary changes to improve a solution or product.
In this workshop, we’ll cover various topics related to creating, reviewing and merging pull requests for beginners, contributors, and maintainers. We’ll discuss how to describe the:
- Motivation and context of pull request
- Tests you’ve done, how to recreate the issue and screenshots if appropriate
- Types of changes eg: bug fix, new feature or breaking change
- The checklist you followed in creating the change.
We’ll also cover how to report sensitive security flaws that can not be shared in a pull request.
For maintainers will discuss how to:
- Accurately review pull requests and give constructive feedback
- Define your projects merging policy - some example “We only accept pull requests after the matter has been discussed thoroughly in an issue”
