Skip to content

Conversation

@JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Oct 13, 2025

Summary by CodeRabbit

  • Documentation
    • Added a new “How to Contribute” post outlining contribution steps and expectations.
    • Includes TL;DR tips, reviewer roles, PR opening/management, draft PRs, and workflow from initial bot review to merge.
    • Clarifies commit conventions (e.g., Conventional Commits, squash-merge) and coding style.
    • Provides guidance for outcomes if a PR isn’t merged and ways to support the project (donations, open data, translations).

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 13, 2025

Walkthrough

Adds a new blog post at _posts/2025-10-20-contributing.md with front matter and a detailed contribution guide describing roles, PR workflow, commit conventions, coding style, review stages, outcomes, and ways to support the project.

Changes

Cohort / File(s) Summary
Documentation: Contribution Guide
_posts/2025-10-20-contributing.md
New markdown post introducing contribution guidelines, front matter metadata, PR process (drafts, reviews, merging), commit style (Conventional Commits, squash), reviewer roles, and post-PR paths, plus project support options.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A hop, a bop, I thump with cheer,
New paths to contribute now appear!
With tidy commits and PRs in queue,
I twitch my whiskers—reviews ensue.
Merge or iterate, we never quit—
Carrots for docs; we’ve polished it. 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The title “contributing” is overly generic and does not clearly convey that the pull request adds a new contribution guide post to the blog. It fails to summarize the main change or provide context for reviewers and future readers. According to the guidelines, a title should be concise yet descriptive enough to highlight the primary change. This title does not meet those criteria and risks leaving the purpose of the PR unclear. Please revise the title to clearly reference the addition of the new contribution guide post, for example “Add contribution guide post for OpenVoiceOS blog.” A more descriptive title will help reviewers and future contributors understand the PR’s purpose at a glance.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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
  • Commit unit tests in branch contirbuting

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
Contributor

@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: 0

🧹 Nitpick comments (1)
_posts/2025-10-20-contributing.md (1)

5-5: Align the post date metadata.

The filename encodes 2025-10-20, but the front matter date is 2025-10-11. Jekyll will prioritize the front matter value, so the post ends up dated differently than the filename suggests. Please pick one date and use it in both places for clarity.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b4a7cb0 and c0e1aea.

⛔ Files ignored due to path filters (1)
  • public/assets/blog/contributing/thumb.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • _posts/2025-10-20-contributing.md (1 hunks)

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