pieterherman-dev / PR-Template-Guide

Repository showcasing a pull request template, designed to improve and standardize PR practices. Features an easy-to-follow Markdown template ideal for open-source contributors and developers.

PR-Template-Guide

Introduction

Welcome to PR-Template-Guide, a repository crafted to enhance clarity and consistency in pull requests. This resource is designed for open-source contributors and developers, aiming to streamline and elevate the PR process.

Template Portfolio

Within the .github/PULL_REQUEST_TEMPLATE/ directory, you'll find several Markdown templates, each tailored for different PR scenarios:

• Feature Template: For new feature additions.
• Bugfix Template: For bug fixes.
• Documentation Template: For documentation updates.
• Refactoring Template: For code structure improvements.
• Hotfix Template: For urgent fixes in production.
• Security Patch Template: For security updates.
• UI/UX Improvement Template: For UI/UX enhancements.
• General Template: PULL_REQUEST_TEMPLATE.md for general use if no specific template fits your needs.

These templates are crafted with best practices in mind, ensuring clear and comprehensive contributions.

Selecting the Right Template

To select a specific PR template for your pull request:

1. Start creating your pull request as usual.
2. In your repository's 'Compare' page, append ?template=TEMPLATE_NAME.md to the URL, replacing TEMPLATE_NAME with the name of your desired template.
3. The template will automatically populate the PR description.

Note: If you don't specify a template, the default PULL_REQUEST_TEMPLATE.md will be used.

Best Practices and Tips

• Detail Oriented: Provide comprehensive descriptions in PRs.
• Issue Linking: Connect PRs with related issues.
• Evidence of Work: Include tests, screenshots, or videos.
• CI/CD Compliance: Ensure PRs pass CI/CD checks.
• Active Engagement: Respond promptly to feedback.
• Use Draft PRs: Open draft PRs for early feedback.
• Performance Insights: Note performance impacts.

Cultivating Positive PR Feedback

• Encourage Dialogue: Promote open, constructive discussions.
• Kindness Counts: Maintain a friendly tone.
• Be Precise and Positive: Start with positive feedback, followed by specific suggestions.
• Ask Questions: Favor questions over direct criticism.
• Provide Context: Explain reasons behind suggestions.
• Express Gratitude: Acknowledge contributors' efforts.
• Patience in Communication: Be clear and patient.

Utilisation Guidelines

To use these templates:

1. Clone or download this repository.
2. From .github/PULL_REQUEST_TEMPLATE/, choose a template.
3. Place it in the same directory in your project's repository.
4. Customize it for your project's needs.

Contributions

Contributions are welcome! For suggestions or improvements, please submit a PR or open an issue. Community collaboration is essential.

Licensing

PR-Template-Guide is licensed under the MIT License. Use and adapt these templates freely.

Thank you for contributing to PR-Template-Guide. Your involvement is crucial in refining collaborative development practices.