Background
During PR review #37, we identified several project-specific standards and technical requirements that should be documented for consistency across contributions. Currently, these standards exist implicitly in our codebase but aren't documented anywhere for contributors to reference.
Problem
Without documented contribution guidelines, contributors may:
- Use inconsistent markdown formatting
- Miss platform-specific requirements (e.g., HuggingFace YAML formatting)
- Be unaware of technical constraints (e.g., MkDocs/Python-Markdown indentation requirements)
- Struggle with local development setup
Proposed Solution
Create a CONTRIBUTING.md file that documents:
Project-Specific Standards
Benefits
- Consistent contribution quality
- Reduced back-and-forth in PR reviews
- Clearer onboarding for new contributors
- Documentation of technical decisions and constraints
Acceptance Criteria
This addresses issues identified during the FAIR Guide checklist review and will help maintain consistency as the project grows.
Background
During PR review #37, we identified several project-specific standards and technical requirements that should be documented for consistency across contributions. Currently, these standards exist implicitly in our codebase but aren't documented anywhere for contributors to reference.
Problem
Without documented contribution guidelines, contributors may:
Proposed Solution
Create a
CONTRIBUTING.mdfile that documents:Project-Specific Standards
Markdown formatting requirements
License format requirements
cc0-1.0notCC0-1.0)Development workflow
mkdocs serveBenefits
Acceptance Criteria
CONTRIBUTING.mdfile in repository rootThis addresses issues identified during the FAIR Guide checklist review and will help maintain consistency as the project grows.