Devesh .ddaku

[deveshio]

Created The Contribution.md file #6

Summary by CodeRabbit

• Documentation
  • Added "Contribution Guidelines" section to outline steps for contributing to the project.
  • Removed "Contribution Guidelines" section from the README, indicating a change in the contribution process or relocation of these guidelines.

[coderabbitai]

Walkthrough

The overall change involves the restructuring of contribution guidelines within a project's documentation. The guidelines have been moved from the readme.md file to a new CONTRIBUTION.md file, streamlining the process for potential contributors to understand how to effectively participate in the project's development.

Changes

File	Change Summary
CONTRIBUTION.md	Added "Contribution Guidelines" section.
readme.md	Removed "Contribution Guidelines" section.

Related issues

• Need for contribution.md #6: The creation of CONTRIBUTION.md addresses the issue's request for a separate contribution file, making it easier for contributors to understand the contribution process.

Poem

🐇✨
In the docs, a change does weave,
A new home for guidelines to leave.
Fork, branch, commit, and PR,
CodeRabbit hops, both near and far. 🌟📝

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Note: For conversation with the bot, please use the review comments on code diffs or files.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 79f9077 and e2ac4dd.

Files selected for processing (2)

• CONTRIBUTION.md (1 hunks)
• readme.md (1 hunks)

Files skipped from review due to trivial changes (1)

• CONTRIBUTION.md

Additional comments: 1

readme.md (1)

• 34-39: > Note: This review was outside the patches, and no patch overlapping with it was found. Original lines [6-6]

The "Contribution Guidelines" section is still listed in the Table of Contents, which is inconsistent with the summary stating that this section was removed. Please ensure that the Table of Contents reflects the current structure of the document.

[coderabbitai]

Consider providing more details or a reference link for setting up environment variables to assist new contributors in getting started.

[ank1traj]

Are you working on the comments?