Skip to content

Commit

Permalink
remove contributing guidelines duplicate
Browse files Browse the repository at this point in the history
link to `docs/contributing.md`
  • Loading branch information
adamperkowski committed Oct 8, 2024
1 parent 49379a7 commit d6f5b65
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 75 deletions.
68 changes: 0 additions & 68 deletions .github/CONTRIBUTING.md

This file was deleted.

1 change: 1 addition & 0 deletions .github/CONTRIBUTING.md
4 changes: 2 additions & 2 deletions .github/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ nav:
- Introduction: 'index.md'
- User Guide: 'userguide.md'
- Contributing:
- Contributing Guide: 'contribute.md'
- Contributing Guide: 'contributing.md'
- Roadmap: 'roadmap.md'
- Documentation:
- Known Issues: 'KnownIssues.md'
Expand Down Expand Up @@ -86,4 +86,4 @@ plugins:
minify_html: true
htmlmin_opts:
remove_comments: true
cache_safe: true
cache_safe: true
16 changes: 11 additions & 5 deletions docs/contribute.md → docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# How to Contribute?
# Contributing Guidelines for Linutil

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:

Expand Down Expand Up @@ -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.

Expand Down

0 comments on commit d6f5b65

Please sign in to comment.