Add CONTRIBUTING.md with project standards and guidelines#56
Merged
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>
gwtaylor
commented
Jul 23, 2025
gwtaylor
commented
Jul 23, 2025
References CONTRIBUTING.md to help new contributors find project guidelines
Closed
egrace479
reviewed
Jul 23, 2025
egrace479
reviewed
Jul 23, 2025
egrace479
reviewed
Jul 23, 2025
Member
|
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. |
hlapp
approved these changes
Jul 28, 2025
Member
hlapp
left a comment
There was a problem hiding this comment.
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>
5 tasks
- 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>
Collaborator
Author
|
@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. |
egrace479
approved these changes
Jul 29, 2025
Member
egrace479
left a comment
There was a problem hiding this comment.
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
gwtaylor
added a commit
that referenced
this pull request
Jul 29, 2025
#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
6 tasks
egrace479
added a commit
that referenced
this pull request
Jan 29, 2026
Pull from Collab Guide [PR 23](Imageomics/Collaborative-distributed-science-guide#23) * docs(tools): add Vale prose linter section * Update docs/wiki-guide/Helpful-Tools-for-your-Workflow.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/wiki-guide/Helpful-Tools-for-your-Workflow.md Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> * Add hyperlinks to Vale style guides in documentation (#56) * Initial plan * Add hyperlinks to Vale style guides (Google, Microsoft, write-good) Co-authored-by: gwtaylor <993736+gwtaylor@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: gwtaylor <993736+gwtaylor@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: gwtaylor <993736+gwtaylor@users.noreply.github.com>
egrace479
added a commit
that referenced
this pull request
Jan 29, 2026
Pull from Collab Guide [PR 23](Imageomics/Collaborative-distributed-science-guide#23) * docs(tools): add Vale prose linter section * Update docs/wiki-guide/Helpful-Tools-for-your-Workflow.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/wiki-guide/Helpful-Tools-for-your-Workflow.md Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> * Add hyperlinks to Vale style guides in documentation (#56) * Initial plan * Add hyperlinks to Vale style guides (Google, Microsoft, write-good) Co-authored-by: gwtaylor <993736+gwtaylor@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: gwtaylor <993736+gwtaylor@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: gwtaylor <993736+gwtaylor@users.noreply.github.com>
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
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.
Summary
Adds a comprehensive
CONTRIBUTING.mdfile 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.0notCC0-1.0) for Hugging Face compatibilityDevelopment Process
mkdocs serveFile 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