Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add comprehensive contribution guidelines #117

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

starc007
Copy link

Description

Added detailed contribution guidelines and improved documentation structure to make it easier for new contributors to get started with the project.

Changes

  • Created comprehensive CONTRIBUTING.md with:
    • Development environment setup
    • Code style and naming conventions based on current codebase
    • Testing guidelines with local nil cluster setup
    • Detailed contribution workflow
    • PR process guidelines
  • Updated README.md with:
    • New Contributing section
    • Quick start guide for contributors
    • Links to resources and documentation

Related Issues

Closes #55

Additional Notes

The contribution guidelines are based on the current project structure and development practices. They should help standardize future contributions and reduce the maintainers' review workload.

Copy link

changeset-bot bot commented Nov 18, 2024

⚠️ No Changeset found

Latest commit: f83a81f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@starc007 starc007 mentioned this pull request Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md
1 participant