Skip to content

Conversation

ankitpokhrel08
Copy link
Contributor

@ankitpokhrel08 ankitpokhrel08 commented Oct 5, 2025

#2243 I built the contribution page!

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive contributing guide covering environment setup (backend/frontend), platform-specific prerequisites, and how to run/build the project.
    • Documented development workflow, testing (backend and frontend), code quality standards, and pre-commit hooks to streamline contributions.
    • Included guidance on making changes, commit conventions, PR process, project structure, and where to get help. No user-facing functionality changes.

Copy link

coderabbitai bot commented Oct 5, 2025

Walkthrough

Adds a new CONTRIBUTING.md file providing a comprehensive contributor guide: project overview, prerequisites, platform-specific setup, Python/frontend development environments, workflows for building/testing/linting, pre-commit hooks, project structure, commit/PR guidelines, and support channels. No code or API changes.

Changes

Cohort / File(s) Summary
Documentation
CONTRIBUTING.md
Added a complete contributor guide covering setup (Python and frontend), development workflow (fork/clone, build, run), testing and linting instructions, pre-commit configuration, project structure, commit/PR guidelines, and support/contact instructions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I twitch my nose and mark the trail,
A map of steps for every tail.
Fork, test, lint—then push with cheer,
Carrots for commits, a ribbon near.
Hop on the branch, the merge is nigh. 🥕🐇

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title accurately reflects the primary change by stating that a contribution.md file was added, which is the main focus of the PR and is clear and specific to a reviewer or teammate.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cd7c3a3 and 2a8e7b3.

📒 Files selected for processing (1)
  • CONTRIBUTION.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • CONTRIBUTION.md

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

github-actions bot commented Oct 5, 2025

📦 Wheel files have been deployed to Cloudflare Pages:

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a4c082a and cd7c3a3.

📒 Files selected for processing (1)
  • CONTRIBUTION.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
CONTRIBUTION.md

154-154: Bare URL used

(MD034, no-bare-urls)


268-268: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

@ankitpokhrel08 ankitpokhrel08 changed the title added proper documentation added contribution.md file Oct 5, 2025
Copy link

github-actions bot commented Oct 5, 2025

📦 Wheel files have been deployed to Cloudflare Pages:

Copy link
Owner

@whitphx whitphx left a comment

Choose a reason for hiding this comment

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

The doc is too verbose and includes wrong/unnecessary contents.
Don't just commit AI-generated texts.

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