Add contributing file

[DropSnorz]

No description provided.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

• 🔍 Trigger a full review

Walkthrough

Adds a new CONTRIBUTING.md file documenting the contribution process for OwlPlug. Covers quick start references, Contributor License Agreement information, issue reporting guidelines, code contribution workflow, pull request requirements including test steps and documentation, and review process expectations.

Changes

Cohort / File(s)	Summary
Contributor Documentation CONTRIBUTING.md	New file establishing contribution guidelines, including CLA requirements, issue/feature request procedures, branching and testing workflow, PR format expectations (titles, descriptions, issue links, UI screenshots, test coverage), and review process.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• Add contributor license agreement #428 — Adds CLA.md file; directly complements this PR as CONTRIBUTING.md references the Contributor License Agreement.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	No pull request description was provided by the author, making it impossible to assess whether any description content is related to the changeset.	Add a pull request description that explains the purpose and content of the CONTRIBUTING.md file, including key sections and guidelines it covers.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Add contributing file' is directly related to the changeset, which adds a CONTRIBUTING.md document to the repository.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[DropSnorz]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@CONTRIBUTING.md`:
- Line 5: Update the four broken documentation links in CONTRIBUTING.md by
replacing "/blob/main/" with "/blob/master/" so the URLs point to the correct
branch; specifically change the README link(s)
"https://github.com/DropSnorz/OwlPlug/blob/main/README.md" to
".../blob/master/README.md" and the CLA links
"https://github.com/DropSnorz/OwlPlug/blob/main/CLA.md" to
".../blob/master/CLA.md" (occurrences referenced on lines 5, 9, 10, and 14).