Скачать или смотреть How to Require a Pull Request Template for Merging on GitHub

Discover how to ensure that contributors fill out essential information in their `pull request templates` before merging into the main branch on GitHub.
---
This video is based on the question https://stackoverflow.com/q/72465647/ asked by the user 'Alan Chen' ( https://stackoverflow.com/u/19181915/ ) and on the answer https://stackoverflow.com/a/72469544/ provided by the user 'bk2204' ( https://stackoverflow.com/u/8705432/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Requirement to populate Pull Request Template

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
The Importance of a Pull Request Template in GitHub

When managing a project on GitHub, one of the crucial aspects of collaboration is ensuring that all contributors provide the necessary information for their pull requests (PRs). This is especially vital for larger teams or open-source projects where clarity can prevent misunderstandings. A pull request template can help by outlining specific fields that contributors should fill out, such as project ticket numbers, descriptions, and any other relevant details. But what if you want to enforce that this template is filled out before a pull request can be merged? Let's explore this important question.

Is It Possible to Enforce a Pull Request Template?

You might be wondering: Is it possible to require someone to fill out a pull request template before merging? Unfortunately, as of now, GitHub does not provide a built-in feature that strictly enforces the completion of pull request templates during the merge process. However, there are alternative strategies you can employ to ensure that your contributors follow through with your requirements.

Implementing a CI Job to Verify Pull Requests

Though you can't directly enforce the completion of a pull request template, you can implement a Continuous Integration (CI) job that checks for necessary information in the pull request before it can be merged. Here’s how you can do this:

Steps to Create a CI Job

Choose a CI Service: Select a CI tool that integrates well with your GitHub repository, such as GitHub Actions, Travis CI, or CircleCI.

Set Up a Job:

Create a job that checks the pull request content.

You can write a script that looks through the PR's body to verify that required fields (like "ticket number") are populated.

Return a Result:

If the CI job finds that the required information is missing, it should return a failure status.

This failure will prevent the pull request from being merged until the author provides the necessary details.

Making the Job User-Friendly

Re-Runnable Jobs: Ensure that your CI job can be easily re-run. This way, once a contributor edits their pull request to include the missing information, they can trigger the CI check again.

Clear Feedback: Customize the CI output to provide clear feedback about which fields were missing. This way, contributors know exactly what to fix.

Additional Tips for Adding Structure to Your PR Process

Documentation: Create a detailed document outlining how to fill out the pull request template and what information is necessary. Link this document in your repository for easy access.

Branch Protection Rules: Although it doesn't enforce the template itself, consider setting up branch protection rules that require certain checks to pass (like your CI job) before merging. This adds another layer of requirement to your process.

Conclusion

While GitHub does not currently allow you to enforce a pull request template directly, using a CI job to verify the inclusion of necessary information can be a practical workaround. By implementing this solution, you can help maintain clarity and consistency in your project's contributions, making collaboration smoother for everyone involved.

By taking the time to set these rules in place, you strengthen your project's workflow and encourage contributors to communicate essential information effectively.