-
-
Notifications
You must be signed in to change notification settings - Fork 49
docs: Create CONTRIBUTING.md #388
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughAdds a new CONTRIBUTING.md documenting contribution guidelines for Nixopus, including a thank-you intro, a note to review community values, and a "Contribution Guide" section linking to the full guide; purely static documentation with no code, configuration, or API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Poem
✨ Finishing Touches🧪 Generate unit tests
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. Comment |
There was a problem hiding this 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 (4)
CONTRIBUTING.md (4)
9-9
: Fix markdownlint: extra space after heading hashRemove the extra space after "##".
-## Code of Conduct +## Code of Conduct
15-15
: Fix markdownlint: extra space after heading hashSame issue here.
-## Contribution Guide +## Contribution Guide
7-14
: Add reporting channel for CoC violations (optional)A one-liner with where/how to report incidents (email or form) improves clarity without duplicating the CoC.
Please read and adhere to our [Code of Conduct](https://docs.nixopus.com/contributing/#code-of-conduct). We are committed to creating an inclusive, respectful, and welcoming environment for all contributors. +If you witness or experience unacceptable behavior, report it via <security@example.com> or the process outlined in the Code of Conduct.
3-6
: Add a quick-start pointer (optional)Consider a short “TL;DR” list linking to Good First Issues and Discussions to funnel newcomers.
Thank you for your interest in contributing to **Nixopus**! We greatly appreciate your efforts to make this project better. Before you get started, please take a moment to review our community values and follow the steps below to contribute effectively. + +Quick start: +- Look for issues labeled “good first issue”. +- Questions? Open a Discussion.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md
(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
9-9: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
15-15: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
🔇 Additional comments (2)
CONTRIBUTING.md (2)
1-6
: Clear, welcoming intro — good additionConcise scope with links out to canonical docs. Nothing blocking.
11-11
: Verified external documentation links and anchors – both URLs return HTTP 200 and thecode-of-conduct
anchor is present. No further changes required.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this 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 (4)
CONTRIBUTING.md (4)
8-8
: Fix markdownlint MD019: double space after heading hash.Change "## Contribution Guide" to a single space.
-## Contribution Guide +## Contribution Guide
5-5
: Tighten wording; there are no “steps below.”Align the sentence with the actual content.
-Before you get started, please take a moment to review our community values and follow the steps below to contribute effectively. +Before you get started, please review our community values and the Contribution Guide below to contribute effectively.
10-10
: Add a visible Code of Conduct link (mentioned in PR description).Surface the CoC directly in this file.
For a comprehensive overview of how to contribute including setting up the development environment, branching strategy, how to run the app, and submission workflows, please refer to our full [Contribution Guide](https://docs.nixopus.com/contributing/). + +## Code of Conduct + +Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) when participating in this project.
- If the canonical CoC lives elsewhere (e.g., docs site), replace
CODE_OF_CONDUCT.md
with the correct URL. Please confirm the path.
12-14
: Trim trailing blank lines.Keeps the file tidy and avoids MD012 in stricter configs.
- - -
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md
(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
8-8: Multiple spaces after hash on atx style heading
(MD019, no-multiple-space-atx)
🔇 Additional comments (1)
CONTRIBUTING.md (1)
1-11
: Overall LGTM; clear, welcoming, and concise.Once the small nits above are addressed, this is good to merge.
@raghavyuva Create a separate files.
|
This PR adds a new CONTRIBUTING.md file that outlines the process for contributing to the project.
It includes:
Link to the full Contribution Guide
Link to the Code of Conduct
To provide clear guidance to new contributors and maintain consistent contribution practices.
Summary by CodeRabbit