docs: update README and CONTRIBUTING with comprehensive guides#47
Merged
docs: update README and CONTRIBUTING with comprehensive guides#47
Conversation
Member
ddjain
commented
Oct 30, 2025
ddjain
commented
- Updated README.md with complete rule documentation (22 rules organized by category)
- Added real-world configuration examples for different teams
- Added troubleshooting guide and best practices
- Updated CONTRIBUTING.md with detailed testing instructions
- Added 'How to test your changes' section with branch and fork workflows
- Included testing tips and debug mode usage examples
- Updated README.md with complete rule documentation (22 rules organized by category) - Added real-world configuration examples for different teams - Added troubleshooting guide and best practices - Updated CONTRIBUTING.md with detailed testing instructions - Added 'How to test your changes' section with branch and fork workflows - Included testing tips and debug mode usage examples
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.