docs: add CONTRIBUTING.md #47
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Awesome! Thanks for taking care of this. I haven't read the content yet. Just a minor suggestion: let's add a link to the guide to README.md to increase its visibility |
|
@novusnota can you check this PR? :) |
Comment on lines
+18
to
+42
| ### Reporting Issues | ||
|
|
||
| - Include code snippets and error messages | ||
| - Include as much detail as possible | ||
| - Include steps to reproduce the issue | ||
| - Include the version of tree-sitter you're using | ||
| - Use code blocks for error messages and logs | ||
|
|
||
| ### Making Changes | ||
|
|
||
| 1. Fork the repository | ||
| 2. Create a new branch for your changes | ||
| 3. Make your changes | ||
| 4. Write or update tests as needed | ||
| 5. Ensure all tests pass | ||
| 6. Format the code using `npm run fmt` | ||
| 7. Submit a pull request | ||
|
|
||
| ### Pull Request Process | ||
|
|
||
| 1. Update the README.md if needed | ||
| 2. Follow the existing code style | ||
| 3. Include a clear description of your changes | ||
| 4. Link any related issues using keywords (e.g., "Fixes #123") | ||
| 5. Wait for review from maintainers |
There was a problem hiding this comment.
I'd probably removed this altogether or moved it somewhere to highlight the dev setup and the overall structure of the project which follows below
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #35