docs: add contributing guidelines to README #236
Merged
Conversation
This file contains hidden or 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
- Add guidelines for forking, cloning, and branching - Document how to run mock and external tests - Add PR guidelines (tests must pass, use template, branch naming) - Add instructions for reporting issues - Note about external test failures due to API changes - Bump version to 0.6.2
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.
Why
Make it easier for new contributors to understand how to contribute to the project. Previously there was no guidance on development workflow, testing, or PR requirements.
What
Tests
No testing needed - documentation only.
Risk and impact
Minimal
Documentation and version bump only, no code changes.