Skip to content

docs: Update CONTRIBUTING.md #705

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.

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

Merged
merged 2 commits into from
Aug 13, 2025
Merged

docs: Update CONTRIBUTING.md #705

merged 2 commits into from
Aug 13, 2025

Conversation

bsbodden
Copy link
Contributor

No description provided.

@bsbodden bsbodden requested a review from Copilot August 12, 2025 18:17
Copilot

This comment was marked as outdated.

@bsbodden bsbodden force-pushed the bsb/update-contrib-guide branch from f991c16 to 2fb457a Compare August 12, 2025 18:51
@bsbodden bsbodden force-pushed the bsb/update-contrib-guide branch from 614812c to 0dbc3ba Compare August 12, 2025 18:59
@bsbodden bsbodden requested review from Copilot and slorello89 August 12, 2025 19:12
Copilot

This comment was marked as outdated.

@bsbodden bsbodden requested a review from Copilot August 12, 2025 21:54
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@bsbodden bsbodden requested a review from abrookins August 13, 2025 13:43
Copy link
Collaborator

@abrookins abrookins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great! Thanks @bsbodden.

@bsbodden bsbodden merged commit dddac5b into main Aug 13, 2025
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants