Add CONTRIBUTING.md with setup, workflow, and PR guidelines #15
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
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.
What & Why
This PR adds a CONTRIBUTING.md file to the CMS repository to help new contributors get started quickly and submit high-quality pull requests. The guide documents environment setup, subproject-specific quickstarts, data handling rules, PR workflow, and issue reporting standards.
What’s included
Quick start instructions for contributing
Subproject-specific setup notes (MAEs, GNNs, E2E)
Environment and dependency guidelines
Data and large file handling rules
PR checklist and suggested PR template content
Bug reporting guidelines
Code style, testing, and CI/smoke test recommendations
Maintainer contact and communication norms
How to test
Review CONTRIBUTING.md for clarity and completeness
Follow the instructions for any subproject to ensure steps are reproducible
Notes
No code changes included
No dependencies added
Intended to improve onboarding, consistency, and review efficiency