From 719548f971cd69c9f4339c65130624154b45d021 Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Wed, 18 Sep 2024 21:18:00 +0200 Subject: [PATCH] Add code understanding & testing point to Contributing Guidelines (#451) * Added `Understand and Test the Code You Write` to contributing guidelines. Co-authored-by: CodingWonders Co-authored-by: nnyyxxxx * Added a notice in `PULL_REQUEST_TEMPLATE.md` * Merge `upstream/main` --------- Co-authored-by: CodingWonders Co-authored-by: nnyyxxxx --- .github/CONTRIBUTING.md | 14 ++++++++++---- .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 5a76af0c..5a2c71b1 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -40,22 +40,28 @@ cd linutil - **Make small, targeted PRs**: Focus on one feature or fix per pull request. This makes it easier to review and increases the likelihood of acceptance. - **Avoid combining unrelated changes**: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem. -## 8. Code Review and Feedback +## 8. Understand and Test the Code You Write + +- **Review your code**: Before submitting your changes, take the time to review your code for readability, efficiency and performance. Consider how your changes affect the project. +- **Avoid using LLMs**: Don't submit AI-generated code without reviewing and testing it first. Ensure that any code you submit is thoroughly understood and meets the project's standards. +- **Testing Requirements**: Failure to conduct testing after multiple requests may result in the closure of your Pull Request. + +## 9. Code Review and Feedback - **Expect feedback**: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed. - **Participate in reviews**: If you feel comfortable, review other contributors' PRs as well. Peer review is a great way to learn and ensure high-quality contributions. -## 9. Contributing Is More Than Just Code +## 10. Contributing Is More Than Just Code - **Test the tool**: Running tests and providing feedback on how the tool works in different environments is a valuable contribution. - **Write well-formed issues**: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue. - **Propose reasonable feature requests**: When suggesting new features, ensure they fit within the scope, style, and design of the project. Provide clear reasoning and use cases. -## 10. Documentation +## 11. Documentation - **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this. -## 11. License +## 12. License - **Agree to the license**: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0e399f7b..4cc787c4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,8 @@ + + ## Type of Change - [ ] New feature - [ ] Bug fix