docs: add CONTRIBUTING.md and improve README with installation guide#125
Open
dashitongzhi wants to merge 1 commit into
Open
docs: add CONTRIBUTING.md and improve README with installation guide#125dashitongzhi wants to merge 1 commit into
dashitongzhi wants to merge 1 commit into
Conversation
Reviewer's GuideAdds a new CONTRIBUTING.md with contributor onboarding, development workflow, and conventions, and updates the README with installation and quick-start guidance for new users. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In the Development Setup section you build with
cargo build --release; for day‑to‑day development it might be clearer to recommendcargo build(debug) and reserve--releasefor explicit production builds. - The Testing section partly duplicates commands listed under Development Setup; consider consolidating or cross‑referencing to avoid getting out of sync and to keep the flow more concise.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the Development Setup section you build with `cargo build --release`; for day‑to‑day development it might be clearer to recommend `cargo build` (debug) and reserve `--release` for explicit production builds.
- The Testing section partly duplicates commands listed under Development Setup; consider consolidating or cross‑referencing to avoid getting out of sync and to keep the flow more concise.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
There was a problem hiding this comment.
Pull request overview
Adds contributor-facing documentation for setting up and contributing to the Rust project. The README update is mentioned in the PR metadata, but only the CONTRIBUTING.md diff was provided for review.
Changes:
- Adds prerequisites, setup, testing, style, commit, PR, issue reporting, and licensing guidance.
- Documents project structure and common Cargo commands for contributors.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
| src/ | ||
| ├── main.rs # Application entry point | ||
| └── lib.rs # Library code (if applicable) |
| 3. **Run tests** | ||
| ```bash | ||
| cargo test | ||
| cargo clippy # Linting |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary\n\nAdded comprehensive contributor documentation:\n\n- CONTRIBUTING.md - Setup instructions, code style, testing guide, conventional commits\n- README.md - Added installation and quick start sections\n\nThese changes help new contributors get started quickly.
Summary by Sourcery
Add contributor guidelines and improve project documentation for setup and contributions.
Documentation: