Skip to content

docs: add CONTRIBUTING.md and improve README with installation guide#125

Open
dashitongzhi wants to merge 1 commit into
Haleclipse:masterfrom
dashitongzhi:docs/add-contributing-and-install-guide
Open

docs: add CONTRIBUTING.md and improve README with installation guide#125
dashitongzhi wants to merge 1 commit into
Haleclipse:masterfrom
dashitongzhi:docs/add-contributing-and-install-guide

Conversation

@dashitongzhi
Copy link
Copy Markdown

@dashitongzhi dashitongzhi commented May 19, 2026

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:

  • Add a CONTRIBUTING guide covering development setup, code style, testing, and pull request workflow.
  • Document conventional commit usage and expectations for reporting issues to the project.

Copilot AI review requested due to automatic review settings May 19, 2026 00:12
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 19, 2026

Reviewer's Guide

Adds 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

Change Details Files
Introduce a contributor guide describing local setup, development workflow, code style, testing, and pull request expectations.
  • Document Rust and Git prerequisites and how to clone and build the project
  • Describe how to run tests, clippy, and formatting commands as part of the dev loop
  • Outline project structure and relevant configuration files for changelog and git hooks
  • Define code style expectations and the use of doc comments for public APIs
  • Adopt Conventional Commits with examples of allowed commit types
  • Specify the standard pull request process and what information to include when reporting issues
  • Clarify that contributions are licensed under the project license
CONTRIBUTING.md
Enhance top-level documentation to help new users install and start using the project quickly.
  • Add installation instructions for setting up the project
  • Provide a quick start section to demonstrate basic usage or first run steps
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread CONTRIBUTING.md
```
src/
├── main.rs # Application entry point
└── lib.rs # Library code (if applicable)
Comment thread CONTRIBUTING.md
3. **Run tests**
```bash
cargo test
cargo clippy # Linting
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants