docs: Add CONTRIBUTING.md for contributor#191
Conversation
WalkthroughA new Changes
Estimated code review effort1 (~2 minutes) Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive CONTRIBUTING.md file to help new contributors understand how to contribute to the queensac Rust project. The document provides clear guidelines for development workflow, code quality standards, and submission processes.
Key changes:
- Added complete contributor documentation covering setup, development workflow, and submission guidelines
- Established code quality requirements including Clippy linting, formatting, and testing standards
- Defined contribution types and coding guidelines for maintainability
| @@ -0,0 +1,84 @@ | |||
| # Contributing to queensac | |||
|
|
|||
| Thank you for your interest in contributing to queensac!! We welcome all kinds of contributions, from bug reports to feature requests and code contributions. | |||
There was a problem hiding this comment.
[nitpick] Double exclamation marks (!!) should be replaced with a single exclamation mark for professional documentation tone.
| Thank you for your interest in contributing to queensac!! We welcome all kinds of contributions, from bug reports to feature requests and code contributions. | |
| Thank you for your interest in contributing to queensac! We welcome all kinds of contributions, from bug reports to feature requests and code contributions. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
CONTRIBUTING.md (5)
3-3: Tone: drop the double exclamation mark for a more formal introExcess punctuation can look unprofessional in technical docs.
-Thank you for your interest in contributing to queensac!! We welcome all kinds of contributions, from bug reports to feature requests and code contributions. +Thank you for your interest in contributing to queensac! We welcome all kinds of contributions, from bug reports to feature requests and code submissions.
13-13: Convert bare URL to markdown linkAvoids triggering MD034 and keeps formatting consistent.
-3. Install Rust if you haven't already: https://rustup.rs/ +3. Install Rust if you haven't already: [rustup.rs](https://rustup.rs/)
35-40: Run Clippy across all targets & features
cargo clippy --all-targets --all-featuresensures examples, tests, and benches are linted too.
Also keeps the command consistent with treating warnings as errors.-cargo clippy -- -D warnings +cargo clippy --all-targets --all-features -- -D warnings
42-47: Mention automatic formatting hookConsider hinting at
cargo fmt --allor a pre-commit hook so contributors don’t push unformatted code.
57-61: Encourage “Closes #” in PR descriptionThis auto-closes the referenced issue once the PR merges and reinforces GitHub best practice.
- - Any relevant issue numbers (e.g., "Fixes #123") + - Any relevant issue numbers with GitHub keywords (e.g., "Closes #123")
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(1 hunks)
🪛 LanguageTool
CONTRIBUTING.md
[style] ~40-~40: Consider using a different verb for a more formal wording.
Context: ...ll treat all warnings as errors. Please fix any issues that arise. #### 2. Code Fo...
(FIX_RESOLVE)
[style] ~84-~84: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2011 characters long)
Context: ... Thank you for contributing to queensac!!
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
13-13: Bare URL used
(MD034, no-bare-urls)
🧰 Additional context used
🪛 LanguageTool
CONTRIBUTING.md
[style] ~40-~40: Consider using a different verb for a more formal wording.
Context: ...ll treat all warnings as errors. Please fix any issues that arise. #### 2. Code Fo...
(FIX_RESOLVE)
[style] ~84-~84: Using many exclamation marks might seem excessive (in this case: 4 exclamation marks for a text that’s 2011 characters long)
Context: ... Thank you for contributing to queensac!!
(EN_EXCESSIVE_EXCLAMATION)
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
13-13: Bare URL used
(MD034, no-bare-urls)
Pull Request Test Coverage Report for Build 16438351623Details
💛 - Coveralls |
♟️ What’s this PR about?
Add
CONTRIBUTING.mdfor contributor.🔗 Related Issues / PRs
Close: #129
Summary by CodeRabbit