Create Merge Request/Pull Request template
Merge request/pull request (MR/PR) templates allow your organizations to have a default text when you create a pull request on GitHub. It is quite useful to make sure to follow a standard process for every pull request and to have a to-do list for the author to check before requesting a review.
A typical user story for MR/PR templates is: As an open source project contributor, I want to submit a merge request/pull request that meets the project requirements so that it can be merged in as quickly and easily as possible. MR/PR templates provide guidance to contributors that lets them know how to meet the project's quality standards for contributions.
Resources about this content type
Maybe start by doing a Google search for "pull request templates" to look for resources and guidelines about this type of content. There's also some links in the comments of this issue of possible examples you could look at.
If you'd like additional help, feel free to reach out to @barbaricyawps !
Want to work on this template?
Great! Make sure you follow our contributing guidelines:
- Check that the template is unassigned. If it is assigned, you might be able to work with the current assignee as a paired writer.
- Join The Good Docs Project Slack workspace.
- Read the template contributing guide.
- You are strongly encouraged to join one of the working groups to get valuable support from the community such as mentorship, Git training, and helpful feedback as you contribute to your first template.
- Request access to the
templates
repository by joining the #tech-requests channel in Slack and posting a request. - Assign yourself to an issue for the template that you want to work on.
- Add the
Template phase:: Research
label to the issue. - Attend your template working group regularly to receive support and resources for your project.