chore: add Contributing.md

[mbreithecker]

Summary by CodeRabbit

• Documentation
  • Introduced a CONTRIBUTING.md file that provides guidelines for contributing to the project, including the development process, coding standards, creating pull requests, and more.

[coderabbitai]

Walkthrough

The new CONTRIBUTING.md file provides essential guidelines for contributing to this project. It outlines the development process, establishes coding standards, details how to create pull requests, and explains chain upgrades. Additionally, it includes sections on testing practices, coding principles, directory structure, and legal considerations, ensuring comprehensive guidance for all contributors.

Changes

Files	Change Summary
CONTRIBUTING.md	Added a new file covering contribution guidelines, development process, coding standards, pull request creation, and chain upgrades.

Poem

In our code's grand tapestry, we weave anew,
Guidelines laid out for every view. 🌟
Testing and coding, principles so tight,
Together we build, with all our might. 🚀
Contributions flowing, like rivers to sea,
A harmony of code, forever free. 🐇💻

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 5

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e8cb38d and 8f636f2.

Files selected for processing (1)

• CONTRIBUTING.md (1 hunks)

Additional context used

LanguageTool

CONTRIBUTING.md

[grammar] ~4-~4: The verb ‘considering’ is used with the gerund form.
Context: # Contributing Thank you for considering to contribute to this project. KYVE is an L1 based on...

(ADMIT_ENJOY_VB)

Markdownlint

CONTRIBUTING.md

23-23: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

---

31-31: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

---

34-34: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

---

3-3: Expected: 1; Actual: 2
Multiple consecutive blank lines

(MD012, no-multiple-blanks)

---

43-43: null
Lists should be surrounded by blank lines

(MD032, blanks-around-lists)

Additional comments not posted (1)

CONTRIBUTING.md (1)

1-1: Grammar: Correct the verb usage.

The verb ‘considering’ is used with the gerund form.

- Thank you for considering to contribute to this project.
+ Thank you for considering contributing to this project.

Likely invalid or redundant comment.