-
Notifications
You must be signed in to change notification settings - Fork 0
Add CONTRIBUTING.md with project standards and guidelines #56
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
Conversation
- Document markdown formatting standards including 4-space indentation requirement - Specify license format requirements for Hugging Face compatibility - Include local development setup and testing procedures - Add quality assurance guidelines and platform-specific considerations - Include conventional commits standard for commit messages - Reference existing tools and configurations Resolves #55 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
References CONTRIBUTING.md to help new contributors find project guidelines
As per online discussion, changed back to draft stage to indicate that more changes are in the works already. Please change back to ready for review once those are in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Up to here content looks great, many thanks @gwtaylor for your work on this and @egrace479 for comments!
- Restructure to emphasize descriptive and atomic commits as primary goals - Add 50-character limit guideline for commit subject lines - Change Conventional Commits from standard to recommendation - Add note about squash merges reducing strict adherence requirement - Fix markdownlint formatting issues 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Change title from "Imageomics Guide" to "Collaborative Distributed Science Guide" - Add context about template repository nature for organizations - Update branch workflow from main to dev branch - Update repository URLs to new template naming - Generalize Code of Conduct reference to "organizational principles" Addresses review feedback from @egrace479 in PR #56 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Add virtual environment creation step with cross-platform commands - Link to Virtual Environments guide for detailed options including conda - Update step numbering for proper sequence - Address review feedback from @egrace479 about environment setup 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
- Add blank lines around fenced code blocks (MD031) - Add blank lines around lists (MD032) - Add blank lines around headings (MD022) - Fix bare URL formatting (MD034) - Ensure consistent markdown formatting throughout 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
@egrace479 I flagged you to have a check of the commit that implements the dev branch and Collaborative Distributed Science Guide retarget. If you're happy with that, this should be good to merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great! Just one small change to add the article in the title (as it is there throughout). Approving with this single change request.
Add definite article to "Collaborative Distributed Science Guide" title for improved readability and consistency with standard naming conventions. Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
ad954f7
to
5493777
Compare
#56) - Add CONTRIBUTING.md with markdown formatting requirements - Document license format specifications for Hugging Face compatibility - Include development workflow and testing procedures - Adopt conventional commits standard with project examples - Add quality assurance guidelines and platform-specific requirements Resolves #55
Summary
Adds a comprehensive
CONTRIBUTING.md
file to document project-specific standards and guidelines that have been identified through PR reviews, particularly during the FAIR Guide implementation in #37.Changes
Key Standards Documented
Markdown Formatting
License Requirements
cc0-1.0
notCC0-1.0
) for Hugging Face compatibilityDevelopment Process
mkdocs serve
File Placement Decision
The file is placed in the repository root (not in
docs/
) to leverage GitHub's automatic detection and integration features for contributing guidelines. This follows standard GitHub conventions while noting that we considered placing it indocs/
for consistency with our existing documentation structure.Testing
mkdocs serve
)Resolves #55
Test Plan
🤖 Generated with Claude Code