Create CONTRIBUTING.md

[nitisht]

This PR adds a contributions guide

Summary by CodeRabbit

• Documentation
  • Introduced new contributor guidelines to help shape the way community members can participate.
  • The guidelines outline various contribution types (e.g., bug fixes, code improvements, tutorials, and documentation enhancements) and provide clear instructions on setting up development environments, creating branches, and managing pull requests.
  • Emphasizes compliance with project standards and proper review processes for a smoother contribution experience.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A new CONTRIBUTING.md file has been added to the repository. The document provides guidelines on how to contribute to the Parseable project, detailing the workflow for forking, branching, and making code changes. It outlines prerequisites, such as adherence to the CLA and using Linux/macOS with Rust version 1.77.1 or above, and specifies GitHub PR best practices and testing procedures.

Changes

File	Change Summary
CONTRIBUTING.md	New file added with comprehensive guidelines covering contribution workflow, environment setup, testing commands, CLA signing, and Git best practices.

Sequence Diagram(s)

sequenceDiagram
    participant C as Contributor
    participant F as Fork (Repository)
    participant B as Branch (New Feature)
    participant PR as Pull Request
    participant R as Review/Bors

    C->>F: Fork the repository
    C->>B: Create a new branch from the fork
    C->>C: Make changes following CONTRIBUTING guidelines
    C->>C: Sign Contributor License Agreement (CLA)
    C->>PR: Submit the Pull Request to main
    PR->>R: Trigger review process
    R->>C: Request updates if needed
    C->>PR: Update branch with main changes
    R->>PR: Approve and merge via Bors

Loading

Poem

I'm a rabbit with a skip and a hop,
New guidelines now help contributions pop!
From forking to merging, the path is clear,
CLA and testing bring us cheer.
I nibble on code with joy so bright—
Hopping along this PR delight!
🐰🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8cbee4d and e3373f2.

📒 Files selected for processing (1)

• CONTRIBUTING.md (1 hunks)

---

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

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[nitisht]

Bypassing tests because of text file changes only