Skip to content

Conversation

Raj-G07
Copy link
Contributor

@Raj-G07 Raj-G07 commented Sep 10, 2025

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

  • Documentation
    • Added a contribution guide for Nixopus describing how to get started and contribute.
    • Includes a thank-you intro and a note to review community values and Code of Conduct (link to full policy).
    • Provides a Contribution Guide section linking to setup, branching, running, and submission workflows.
    • Purely documentation; no code or configuration changes.

Copy link
Contributor

coderabbitai bot commented Sep 10, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.

Walkthrough

Adds 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

Cohort / File(s) Summary of Changes
Docs: Contribution guidelines
`CONTRIBUTING.md`
Added new static documentation outlining contribution process, including a thank-you intro, link to community values/Code of Conduct, and a pointer to the full Contribution Guide at https://docs.nixopus.com/contributing/; no functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks (3 passed)

✅ 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 “docs: Create CONTRIBUTING.md” clearly and concisely communicates the primary change—adding the CONTRIBUTING.md documentation file—to anyone reviewing the project history. It adheres to conventional commit conventions with the “docs:” prefix and directly matches the main update described in the pull request summary. There is no unnecessary detail or noise, and it immediately informs a teammate what to expect from the changeset.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

Poem

I twitch my nose at CONTRIBUTING lines,
Hopscotch rules where collaboration shines.
Carrots of conduct, guides in a row—
Paths to burrows every helper should know.
Thump-thump! Docs planted; now watch them grow. 🥕✨

✨ 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

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 (4)
CONTRIBUTING.md (4)

9-9: Fix markdownlint: extra space after heading hash

Remove the extra space after "##".

-##  Code of Conduct
+## Code of Conduct

15-15: Fix markdownlint: extra space after heading hash

Same 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

📥 Commits

Reviewing files that changed from the base of the PR and between 68023e4 and 4381d42.

📒 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 addition

Concise scope with links out to canonical docs. Nothing blocking.


11-11: Verified external documentation links and anchors – both URLs return HTTP 200 and the code-of-conduct anchor is present. No further changes required.

@Raj-G07 Raj-G07 changed the title Create CONTRIBUTING.md docs: Create CONTRIBUTING.md Sep 10, 2025
Copy link
Owner

@raghavyuva raghavyuva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Raj-G07 i have added few minor changes to this, can you seperate out code of conduct and contributing files thus by adhering to github community guidelines for our repository, kindly join discord for discussing more on this,

Appreciate your work on this!

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 (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

📥 Commits

Reviewing files that changed from the base of the PR and between 4381d42 and 1ea9e14.

📒 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.

@Raj-G07
Copy link
Contributor Author

Raj-G07 commented Sep 10, 2025

@raghavyuva Create a separate files.

@Raj-G07 Raj-G07 requested a review from raghavyuva September 10, 2025 14:50
@zhravan zhravan changed the base branch from master to feat/develop September 10, 2025 21:20
@zhravan zhravan merged commit 8efe768 into raghavyuva:feat/develop Sep 10, 2025
3 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Sep 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants