Skip to content

Latest commit

 

History

History
45 lines (37 loc) · 1.13 KB

File metadata and controls

45 lines (37 loc) · 1.13 KB

Contributing Guidelines

Code of Conduct

  • Be respectful and professional
  • Follow open science principles
  • Maintain data privacy and security
  • Document all changes and decisions

Getting Started

  1. Fork the repository
  2. Create a new branch for your contribution
  3. Set up the development environment using environment.yml

Making Changes

  1. Follow the project structure
  2. Document your code
  3. Use clear commit messages
  4. Update relevant documentation

Experiment Guidelines

  1. Use the template in experiments/_template/
  2. Register new experiments in experiments/experiment_registry.md
  3. Maintain complete documentation
  4. Version control all code and configurations

Code Style

  • Follow PEP 8 for Python code
  • Use Black for code formatting
  • Write clear docstrings
  • Include type hints where appropriate

Pull Request Process

  1. Update documentation
  2. Run all tests
  3. Request review from maintainers
  4. Address review comments

Documentation

  • Keep README.md updated
  • Document all dependencies
  • Maintain clear experiment logs
  • Update data dictionaries

Questions?

Contact the project maintainers for guidance.