From 7c8f961288a3b0bea359007d7fd083c7d7207544 Mon Sep 17 00:00:00 2001 From: Giovanni Pellerano Date: Thu, 14 Nov 2024 14:22:14 +0100 Subject: [PATCH] Revise texts of PULL REQUEST and CONTRIBUTING guidelines --- .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++-------- CONTRIBUTING.md | 6 ++++-- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 10d192ad22..be43bf55a8 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,9 +1,8 @@ -Before you submit a pull request, please make sure: +Before submitting a pull request, please ensure the following: -- [ ] The pull request should include a description of the problem you're trying to solve -- [ ] The pull request should include overview of the suggested solution -- [ ] If the pull requests changes current behavior, reasons why your solution is better. -- [ ] The proposed code should be fully functional -- [ ] The proposed code should contain tests relevant to prove is functionality -- [ ] The proposed tests should ensure significative code coverage -- [ ] All new and existing tests should pass +- [ ] The pull request includes a description of the problem you're trying to solve. +- [ ] The pull request provides an overview of the suggested solution. +- [ ] The proposed code is fully functional. +- [ ] The proposed code includes relevant tests to verify its functionality. +- [ ] All new and existing tests pass successfully. +- [ ] Overall code quality and test coverage metrics are not reduced by more than 0.5% diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b020714a49..982cac83d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,9 +77,11 @@ Before you submit your Pull Request consider the following guidelines: 7. Run the full GlobaLeaks test suite and ensure that all tests pass. -8. Commit your changes using a descriptive commit message. +8. Ensure overall code quality and test coverage metrics are not reduced by more than 0.5% -9. In GitHub, send a pull request to `GlobaLeaks:main`. +9. Commit your changes using a descriptive commit message. + +10. In GitHub, send a pull request to `devel` branch. ## Donations heart icon As a pure community-driven project without major corporate backing, we also welcome [donations](https://github.com/sponsors/globaleaks).