Skip to content

Conversation

teresper-eth
Copy link
Collaborator

@teresper-eth teresper-eth commented Sep 27, 2025

Summary by CodeRabbit

  • Documentation
    • Added comprehensive contributing guidelines to help new contributors get started quickly.
    • Included development setup steps, testing and migration workflows, and environment configuration guidance.
    • Documented coding conventions, validation and error-handling practices, and authentication expectations.
    • Outlined branching strategy, commit practices, and pull request checklists for consistent collaboration.
    • Clarified issue reporting process, security considerations, and licensing information.
    • No changes to application behavior or public APIs.

Copy link
Contributor

coderabbitai bot commented Sep 27, 2025

Walkthrough

Added a new CONTRIBUTING.md documenting contribution guidelines, development setup, project conventions, workflows, and policies. No source code or API behavior changes.

Changes

Cohort / File(s) Summary of Changes
Documentation
CONTRIBUTING.md
Added comprehensive contributor guide covering contribution types, local setup, Prisma/migrations, scripts, testing, conventions (TypeScript/Fastify/validation/auth/rate limits/errors), Git workflow, PR checklist, issue reporting, security, and license.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

  • metanodreamer

Poem

A hare with pen, I tap-tap-tap—
New paths to help our burrow map.
Forks and branches, tests to run,
Linting moons and build-sun.
Contrib carrots neatly stacked—
Now every hop stays on track! 🥕🐇

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 and concisely describes adding a contributing guide for the Devoter API under the docs category, reflecting the sole addition of a CONTRIBUTING.md file. It follows the “docs:” prefix convention and omits unnecessary details, making the primary change immediately clear. This phrasing ensures any reviewer scanning the history understands the purpose of the pull request at a glance.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/contributing

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: 1

🧹 Nitpick comments (1)
CONTRIBUTING.md (1)

49-52: Wrap bare URL to satisfy markdownlint

markdownlint (MD034) flags http://localhost:3000 as a bare URL. Wrapping it in angle brackets keeps the lint job green with no behavioral impact.

Apply this diff:

-- `CORS_ORIGIN` (default: http://localhost:3000)
+- `CORS_ORIGIN` (default: <http://localhost:3000>)
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0f0e499 and 791da71.

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

51-51: Bare URL used

(MD034, no-bare-urls)

@metanodreamer metanodreamer merged commit b172120 into main Sep 27, 2025
1 check passed
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