You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+10-4Lines changed: 10 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,22 +40,28 @@ cd linutil
40
40
-**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.
41
41
-**Avoid combining unrelated changes**: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem.
42
42
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
44
50
45
51
-**Expect feedback**: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed.
46
52
-**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.
47
53
48
-
## 9. Contributing Is More Than Just Code
54
+
## 10. Contributing Is More Than Just Code
49
55
50
56
-**Test the tool**: Running tests and providing feedback on how the tool works in different environments is a valuable contribution.
51
57
-**Write well-formed issues**: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue.
52
58
-**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.
53
59
54
-
## 10. Documentation
60
+
## 11. Documentation
55
61
56
62
-**Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this.
57
63
58
-
## 11. License
64
+
## 12. License
59
65
60
66
-**Agree to the license**: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license.
0 commit comments