add CONTRIBUTING.md

[dyc3]

Summary by CodeRabbit

• Documentation
  • Created CONTRIBUTING.md with comprehensive guidelines for contributors.
  • Updated README.md to streamline setup information and direct users to CONTRIBUTING.md for detailed instructions.

[coderabbitai]

Walkthrough

The project's documentation has been reorganized. Detailed guidelines for development processes like environment setup, testing, and running the application have been moved from README.md to a new CONTRIBUTING.md file. This streamlines the main readme and centralizes contributor instructions.

Changes

File	Change Summary
CONTRIBUTING.md	Added with guidelines for development environment and testing.
README.md	Simplified by removing detailed setup instructions; now references CONTRIBUTING.md.

🐇✨
To the code burrow deep and wide,
A new guide hops by our side.
In CONTRIBUTING fields we play,
With clearer paths to code away.
🌟🐾

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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

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

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 5d7baad and bf9fb8a.

Files selected for processing (2)

• CONTRIBUTING.md (1 hunks)
• README.md (1 hunks)

Files skipped from review due to trivial changes (1)

• README.md

Additional comments: 5

CONTRIBUTING.md (5)

• 1-5: The introduction is clear and sets the right expectations for the contributors. It's good to see options for setting up the development environment.

• 7-11: The prerequisites section is well-written, providing clear guidance on the tools needed for the project. It's beneficial to recommend nvm for managing node versions and the GitHub CLI for pull requests.

• 41-48: The devcontainer setup instructions are concise and easy to follow. It's good to see the use of modern development tools like Docker and VSCode to simplify the setup process.

• 50-81: The testing section is thorough, covering all necessary steps to ensure the application is working correctly. Instructions for running tests in headed mode are particularly useful for debugging.

• 83-101: The instructions on how to run the project are clear and account for different operating systems. The inclusion of separate debugging instructions for the client and server is a thoughtful addition for developers.