Skip to content

Commit 719548f

Browse files
adamperkowskiCodingWondersnnyyxxxx
authored
Add code understanding & testing point to Contributing Guidelines (#451)
* Added `Understand and Test the Code You Write` to contributing guidelines. Co-authored-by: CodingWonders <CodingWonders@users.noreply.github.com> Co-authored-by: nnyyxxxx <nnyyxxxx@users.noreply.github.com> * Added a notice in `PULL_REQUEST_TEMPLATE.md` * Merge `upstream/main` --------- Co-authored-by: CodingWonders <CodingWonders@users.noreply.github.com> Co-authored-by: nnyyxxxx <nnyyxxxx@users.noreply.github.com>
1 parent 1d2d51e commit 719548f

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

.github/CONTRIBUTING.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,22 +40,28 @@ cd linutil
4040
- **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.
4141
- **Avoid combining unrelated changes**: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.
4242

43-
## 8. Code Review and Feedback
43+
## 8. Understand and Test the Code You Write
44+
45+
- **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.
46+
- **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.
47+
- **Testing Requirements**: Failure to conduct testing after multiple requests may result in the closure of your Pull Request.
48+
49+
## 9. Code Review and Feedback
4450

4551
- **Expect feedback**: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed.
4652
- **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.
4753

48-
## 9. Contributing Is More Than Just Code
54+
## 10. Contributing Is More Than Just Code
4955

5056
- **Test the tool**: Running tests and providing feedback on how the tool works in different environments is a valuable contribution.
5157
- **Write well-formed issues**: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue.
5258
- **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.
5359

54-
## 10. Documentation
60+
## 11. Documentation
5561

5662
- **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this.
5763

58-
## 11. License
64+
## 12. License
5965

6066
- **Agree to the license**: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.
6167

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
<!--
2+
Read Contributing Guidelines before opening a PR.
3+
https://github.com/ChrisTitusTech/linutil/blob/main/.github/CONTRIBUTING.md
4+
-->
5+
16
## Type of Change
27
- [ ] New feature
38
- [ ] Bug fix

0 commit comments

Comments
 (0)