Add Contributing Guidelines

[Mab879]

• Add Contributing Guidelines
• Add more CI and CI config
• Add DCO

Summary by CodeRabbit

• Documentation

  • Added a comprehensive CONTRIBUTING guide with setup steps and contribution workflow.
  • Introduced a Developer Certificate of Origin and linked it from the README.
  • Clarified README intro, usage wording, and licensing statement.

• Chores

  • Expanded CI to run on pull requests, pushes, and merge groups.
  • Updated pre-commit settings to avoid auto-creating commits on autofix.

[coderabbitai]

Walkthrough

Expanded CI workflow triggers to run on pull_request, push, and merge_group. Disabled pre-commit autofix commits in configuration. Added CONTRIBUTING guide and DCO file. Updated README wording and added Contributing section referencing DCO. No functional code changes beyond CI trigger configuration.

Changes

Cohort / File(s)	Summary of Changes
CI/CD & Tooling .github/workflows/deploy.yaml, .pre-commit-config.yaml	Workflow now triggers on pull_request, push, and merge_group; steps unchanged. Pre-commit config adds autofix_commit: false at top level; hooks otherwise unchanged.
Documentation CONTRIBUTING.md, README.md, DCO	Adds contributor guide with env/setup/flow instructions and pre-commit notes. Adds DCO v1.1 text. README tweaks wording, adds Contributing section linking to guide and noting DCO, and clarifies license phrasing/punctuation.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor Dev as Developer
  participant GH as GitHub
  participant WF as Deploy Workflow

  Dev->>GH: push / open PR / merge group
  Note over GH: Events: pull_request, push, merge_group
  GH-->>WF: Trigger workflow
  rect rgb(230,240,255)
  note right of WF: Workflow steps unchanged
  WF->>WF: Run existing build/deploy jobs
  end
  WF-->>GH: Report status

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

A bunny taps CI with gentle paws,
New triggers hop on every cause;
Pre-commit won’t auto-chirp, it’s tame,
Docs now guide the contribution game.
With DCO signed and carrots bright,
We merge by moonlit, linted night. 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Title Check	⚠️ Warning	The title “Add Contributing Guidelines” only highlights the new CONTRIBUTING.md but omits other substantial updates in this changeset such as CI workflow adjustments, the Developer Certificate of Origin header, and related README modifications, so it does not fully summarize the main changes.	Revise the title to reflect all major changes—for example, “Add contributing guidelines, CI config updates, and DCO header”—so it accurately conveys the scope of the pull request.

✅ 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

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

CONTRIBUTING.md (1)

67-71: Fix Markdown formatting and typos in the contribution checklist.

The inline code formatting for “-s” is missing a closing backtick, and “pull reqeust” is misspelled. These issues break the rendered formatting. Please update the line to something like “Please sign off (using -s or --sign-off).” and fix “pull request.”

🧹 Nitpick comments (1)

CONTRIBUTING.md (1)

45-48: Correct the Windows section wording.

Line 46 currently reads “It is sugguested…”. Please correct the spelling (“suggested”) so the guidance stays professional.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 8a7a579 and d1a79ff.

📒 Files selected for processing (5)

• .github/workflows/deploy.yaml (1 hunks)
• .pre-commit-config.yaml (1 hunks)
• CONTRIBUTING.md (1 hunks)
• DCO (1 hunks)
• README.md (3 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

CONTRIBUTING.md

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

(MD040, fenced-code-language)

---

34-34: Dollar signs used before commands without showing output

(MD014, commands-show-output)

---

35-35: Dollar signs used before commands without showing output

(MD014, commands-show-output)

---

36-36: Dollar signs used before commands without showing output

(MD014, commands-show-output)

---

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

(MD040, fenced-code-language)

---

41-41: Dollar signs used before commands without showing output

(MD014, commands-show-output)

---

69-69: Spaces inside code span elements

(MD038, no-space-in-code)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: deploy