docs: Update CONTRIBUTING.md #705
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
bsbodden
force-pushed
the
bsb/update-contrib-guide
branch
from
f991c16 to
2fb457a
Compare
bsbodden
force-pushed
the
bsb/update-contrib-guide
branch
from
614812c to
0dbc3ba
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive CONTRIBUTING.md file to the Redis OM Python project, providing detailed guidance for contributors on development setup, workflow, and project conventions. The documentation emphasizes the unique dual async/sync architecture where changes must be made to the async codebase first and then synchronized to generate the sync version.
- Adds complete contributor documentation covering setup, architecture, workflow, testing, and submission guidelines
- Updates the wordlist to include new technical terms used in the documentation
Reviewed Changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | New comprehensive contributor guide with setup instructions, development workflow, and project-specific conventions |
| .github/wordlist.txt | Updates wordlist with technical terms from the new documentation |
Comments suppressed due to low confidence (1)
CONTRIBUTING.md:68
- [nitpick] The emoji character '🚨' may not display properly in all environments. Consider using a text-based marker like '
⚠️ WARNING:' or 'CRITICAL:' for better compatibility.
### �� Critical: Dual Async/Sync Architecture
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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.
No description provided.