- Be respectful and professional
- Follow open science principles
- Maintain data privacy and security
- Document all changes and decisions
- Fork the repository
- Create a new branch for your contribution
- Set up the development environment using
environment.yml
- Follow the project structure
- Document your code
- Use clear commit messages
- Update relevant documentation
- Use the template in
experiments/_template/ - Register new experiments in
experiments/experiment_registry.md - Maintain complete documentation
- Version control all code and configurations
- Follow PEP 8 for Python code
- Use Black for code formatting
- Write clear docstrings
- Include type hints where appropriate
- Update documentation
- Run all tests
- Request review from maintainers
- Address review comments
- Keep README.md updated
- Document all dependencies
- Maintain clear experiment logs
- Update data dictionaries
Contact the project maintainers for guidance.