Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (61 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

94 lines (61 loc) · 2.1 KB

Contributing to MEGaNorm

Thank you for considering contributing to MEGaNorm! We welcome contributions from the community to improve and extend the toolbox. This guide will help you get started.

🚀 Ways to Contribute

  • Bug reports: Found a bug? Please open an issue.
  • Feature requests: Have an idea for a new feature? We'd love to hear it.
  • Code contributions: Improve the codebase, fix bugs, or add new functionality.
  • Documentation: Help improve or expand the documentation and tutorials.
  • Testing: Write or improve unit tests.

⚖️ Code of Conduct

Please be respectful and constructive. This project follows the Contributor Covenant Code of Conduct.

🚪 Getting Started

  1. Fork the repository and clone your fork:

    git clone https://github.com/your-username/MEGaNorm.git
cd MEGaNorm

  2. Set up your environment:

    conda create --name meganorm-dev python=3.12
conda activate meganorm-dev
pip install -e .[dev]

  3. Create a new branch:

    git checkout -b feature/my-new-feature

  4. Make your changes, write tests, and commit:

    git add .
git commit -m "Add feature: my new feature"

  5. Push to your fork and open a pull request:

    git push origin feature/my-new-feature

    Then open a Pull Request.

✏️ Style Guide

✅ Running Tests

Make sure your changes don’t break anything:

pytest tests/

Use pytest --cov to check test coverage.

🚀 Thank You!

Your contribution will help advance open, reproducible neuroimaging research. We appreciate your help making MEGaNorm better!