From cf679dddceffb35567cf58d1de177aa88d342df3 Mon Sep 17 00:00:00 2001 From: Josep Boix Requesens Date: Tue, 20 Feb 2024 16:09:26 +0100 Subject: [PATCH 1/2] feat: add pull request template guide Introduces a guide on the importance of adding a pull request template. The guide explains how a pull request template improves collaboration and serves as a form of documentation. A generic pull request template has been added to said guide. --- .editorconfig | 2 + .github/pull_request_template.md | 19 +++++++ public/_sidebar.md | 1 + public/guides/CONTRIBUTING_GUIDE.md | 6 +++ public/guides/PULL_REQUEST_GUIDE.md | 82 +++++++++++++++++++++++++++++ public/index.html | 44 ++++++++-------- 6 files changed, 132 insertions(+), 22 deletions(-) create mode 100644 .github/pull_request_template.md create mode 100644 public/guides/PULL_REQUEST_GUIDE.md diff --git a/.editorconfig b/.editorconfig index 3aff376..a5e6ef5 100644 --- a/.editorconfig +++ b/.editorconfig @@ -7,6 +7,8 @@ end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true +indent_style=space +indent_size=2 [*.md] max_line_length = 100 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..b5e2991 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ +## Description + +> Please provide a brief summary of the changes made. Include the specific guideline that is being +> addressed or added, and explain its significance. + +> Please explain why this change was necessary. Was there a lack of clarity? Was the information +> outdated? Or is this a new addition to the guidelines? + +## Changes Made + +> Please detail the modifications made. This could include areas such as changes in content, +> structure, or formatting. + +## Checklist: + +- [ ] I have followed the style guidelines of this project. +- [ ] I have performed a self-review of my own changes. +- [ ] I have made corresponding changes to the documentation. +- [ ] I have reviewed the [CONTRIBUTING.md](../docs/CONTRIBUTING.md) guidelines. diff --git a/public/_sidebar.md b/public/_sidebar.md index ebb0d25..3f97a95 100644 --- a/public/_sidebar.md +++ b/public/_sidebar.md @@ -7,4 +7,5 @@ * [Crafting a Readme](/guides/README_GUIDE.md) * [Understanding Licenses](/guides/LICENSE_GUIDE.md) * [Contributor's Handbook](/guides/CONTRIBUTING_GUIDE.md) +* [Pull Request Manual](/guides/PULL_REQUEST_GUIDE.md) * [Code of Conduct Guidelines](/guides/CODE_OF_CONDUCT_GUIDE.md) diff --git a/public/guides/CONTRIBUTING_GUIDE.md b/public/guides/CONTRIBUTING_GUIDE.md index 25877f2..19a7359 100644 --- a/public/guides/CONTRIBUTING_GUIDE.md +++ b/public/guides/CONTRIBUTING_GUIDE.md @@ -22,6 +22,12 @@ Add a file called `CONTRIBUTING.md` to the root of your repository, the `docs` f the `.github` folder, with the text you wrote. GitHub automatically adds a link to this file in the _About_ section of your repository homepage. +## Next steps + +Now that you've added a Contributing Guide to your project, you can help contributors further with +a pull request template. Follow-up with our [Pull Request Manual][pr-guide]. + [github-documentation]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors [pillarbox-contributing]: https://github.com/SRGSSR/pillarbox-apple/blob/main/docs/CONTRIBUTING.md [contributing-template]: https://github.com/nayafia/contributing-template +[pr-guide]: ./PULL_REQUEST_GUIDE diff --git a/public/guides/PULL_REQUEST_GUIDE.md b/public/guides/PULL_REQUEST_GUIDE.md new file mode 100644 index 0000000..40b6a50 --- /dev/null +++ b/public/guides/PULL_REQUEST_GUIDE.md @@ -0,0 +1,82 @@ +# Pull Request Manual + +Pull Requests are an integral aspect of a collaborative project. Through this process, contributors +can propose modifications, enhancements, or new features to a codebase. **The true strength of a +pull request lies in the subsequent peer review.** + +## Why Code Reviewing Matters + +- **Code Quality and Consistency:** Code reviewing ensures that the code adheres to established + standards, follows best practices, and maintains a high level of quality. +- **Knowledge Sharing:** With code reviews, contributors can learn from each other's problem-solving + approaches, coding styles, promoting a culture of continuous learning within the team. +- **Bug Prevention:** A fresh set of eyes often catches issues that the original author might have + overlooked. + +## The Pull Request Template + +The pull request template is a valuable tool for creating a successful pull request. It is a guide +to help contributors understand what is expected of them. + +Here are some reasons why adding a pull request template to your repository is important: + +- **Clarity and Consistency**: A pull request template ensures that every contributor provides the + necessary information when proposing changes. +- **Efficiency**: With a template, reviewers don't have to ask basic questions about the pull + request, as most of the essential details should be included in the template. +- **Documentation**: Detailed pull requests serve as a form of documentation, providing insight into + the project's history and the rationale behind certain decisions. +- **Quality Control**: A checklist in the template can serve as a reminder for contributors to + adhere to the project's standards and guidelines, leading to higher quality submissions. + +### Adding a Pull Request Template + +You can store your pull request template here: `.github/pull_request_template.md`. You can review +other options on the following GitHub documentation: + +[Creating a pull request template for your repository][github-creating-pr-template]. + +### Example + +Here's an example of a pull request template; feel free to use it in your project and modify it to +your needs: + +```markdown +## Description + +> Please provide a brief summary of the changes made. Please explain why +> this change was necessary. Was there a problem or an issue this change +> will address? What will be improved with this change? + +## Changes Made + +> Please detail the modifications made. This could include areas such as +> code, documentation, structure, or formatting. + +## Checklist + +- [ ] I have followed the project's style guidelines. +- [ ] I have performed a self-review of my own changes. +- [ ] I have made corresponding changes to the documentation. +- [ ] My changes do not generate new warnings. +- [ ] I have added tests that prove my fix is effective or that my feature works. +- [ ] I have reviewed the contribution guidelines. +``` + +#### Creating a Checklist + +You can add a **Checklist** section to further guide contributors. In this section, add items that +reflect the "Definition of Done" for your project or any specific guidelines mentioned in the +"Contributing" section of the README. This could include items like: + +- My code follows the code style of this project. +- I have added tests to cover my changes. +- All new and existing tests passed. +- My changes generate no new warnings. +- I have updated the documentation accordingly. + +> [!Note] +> Remember, the goal of the pull request template is to make collaboration easier by setting clear +> expectations for contributions. Tailor it to suit the specific needs of your project. + +[github-creating-pr-template]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository diff --git a/public/index.html b/public/index.html index a60db3f..ff4ee8d 100644 --- a/public/index.html +++ b/public/index.html @@ -1,32 +1,32 @@ - - RTS Development Guidelines - - - - - - + + RTS Development Guidelines + + + + + +
From 24c973171df4bdaf50c4510d89ded128d4a183b3 Mon Sep 17 00:00:00 2001 From: Samuel Beaurepaire <110982858+SamuelBeaurepaire@users.noreply.github.com> Date: Fri, 1 Mar 2024 09:08:37 +0100 Subject: [PATCH 2/2] Rewording in PR guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Gaëtan Muller --- public/guides/PULL_REQUEST_GUIDE.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/public/guides/PULL_REQUEST_GUIDE.md b/public/guides/PULL_REQUEST_GUIDE.md index 40b6a50..f6e9593 100644 --- a/public/guides/PULL_REQUEST_GUIDE.md +++ b/public/guides/PULL_REQUEST_GUIDE.md @@ -31,10 +31,8 @@ Here are some reasons why adding a pull request template to your repository is i ### Adding a Pull Request Template -You can store your pull request template here: `.github/pull_request_template.md`. You can review -other options on the following GitHub documentation: - -[Creating a pull request template for your repository][github-creating-pr-template]. +You can store your pull request template in `.github/pull_request_template.md`. +You can review other options on the [GitHub documentation][github-creating-pr-template]. ### Example