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.

Sign up for GitHub

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

Jump to bottom

Add CONTRIBUTING.md #55

Open

ukorvl opened this issue Jun 27, 2024 · 1 comment

Labels

documentation good first issue

Member

ukorvl commented Jun 27, 2024

We need to provide some standard for developers how to make feature requests, report bugs and contribute to the reposiotry.
We already have https://github.com/NilFoundation/nil.js/blob/6454208fe8665ec40c342dca6eb1baa3ef10ede7/.github/CONTRIBUTING.md but there is only a description of how to work with changesets. What should be added as well:

Description of how to setup repository to start development
Naming conventions
How to setup tests and how to test your code with real cluster interaction
Maybe we should move CONTRIBUTING.md to the root of the repository, it looks like a common practice.

The text was updated successfully, but these errors were encountered:

ukorvl added documentation good first issue labels

starc007 mentioned this issue

feat: add comprehensive contribution guidelines #117

Closed

starc007 commented Nov 18, 2024

Hey @ukorvl
I've created PR #117 that addresses all the requested improvements to our contribution guidelines:

✅ Moved CONTRIBUTING.md to the root directory for better visibility
✅ Added comprehensive setup instructions for local development
✅ Documented naming conventions based on our current codebase patterns
✅ Added detailed testing guidelines, including local cluster setup
✅ Included clear workflow for issues and PRs
✅ Updated README.md with a new contributing section

Please review the changes and let me know if anything needs adjustment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment