Add CONTRIBUTING.md with comprehensive contribution guidelines #658
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
- Environment setup instructions with uv - Development workflow and branch naming conventions - Project structure overview - Coding guidelines and style recommendations - Testing and documentation standards - Pull request submission process - Addresses issue #655
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive CONTRIBUTING.md file to help standardize the contribution workflow and reduce onboarding friction for new contributors to the MSML project.
Changes:
- Created a detailed CONTRIBUTING.md covering environment setup, development workflow, project structure, coding guidelines, testing standards, and PR submission process
- Included concrete examples of code style, commit messages, and branch naming conventions
- Provided step-by-step instructions for setting up the development environment using uv
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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.
Closes #655
Summary
This PR adds a comprehensive CONTRIBUTING.md file to standardize the contribution workflow and reduce onboarding friction for new contributors.
Changes
Benefits
Related