Skip to content

Commit 00ff87c

Browse files
committed
remove contributing guidelines duplicate
link to `.github/CONTRIBUTING.md`
1 parent 49379a7 commit 00ff87c

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

.github/mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ nav:
66
- Introduction: 'index.md'
77
- User Guide: 'userguide.md'
88
- Contributing:
9-
- Contributing Guide: 'contribute.md'
9+
- Contributing Guide: '../.github/CONTRIBUTING.md'
1010
- Roadmap: 'roadmap.md'
1111
- Documentation:
1212
- Known Issues: 'KnownIssues.md'
@@ -86,4 +86,4 @@ plugins:
8686
minify_html: true
8787
htmlmin_opts:
8888
remove_comments: true
89-
cache_safe: true
89+
cache_safe: true

docs/contribute.md renamed to docs/contributing.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to Contribute?
1+
# Contributing Guidelines for Linutil
22

33
Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines:
44

@@ -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

0 commit comments

Comments
 (0)