Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

62 lines (37 loc) · 2.28 KB

Contributing to iEEG Implant Reconstruction Pipeline

Thank you for considering contributing to the iEEG Implant Reconstruction Pipeline! We welcome contributions from the community to help improve the project.

How to Contribute

Reporting Issues

If you encounter any bugs or have suggestions for improvements, please use the GitHub Issue Tracker to report them. When reporting an issue, please include:

  • A clear and descriptive title
  • A detailed description of the problem or suggestion
  • Steps to reproduce the issue (if applicable)
  • Any relevant error messages or screenshots

Proposing Changes

If you have an idea for a new feature or an improvement, we encourage you to discuss it with us first. You can do this by opening a new issue or starting a discussion in the existing issues.

Submitting Pull Requests

If you are ready to contribute code, please follow these steps:

  1. Fork the Repository: Create a personal fork of the repository on GitHub.

  2. Clone the Fork: Clone your fork to your local machine.

    git clone https://github.com/n-sinha/iEEG_implant_reconstruction.git

  3. Create a Branch: Create a new branch for your changes.

    git checkout -b feature/your-feature-name

  4. Make Changes: Implement your changes in the new branch.

  5. Test Your Changes: Ensure that your changes work as expected and do not break existing functionality.

  6. Commit Your Changes: Commit your changes with a descriptive commit message.

    git commit -m "Add feature: your feature description"

  7. Push to Your Fork: Push your changes to your fork on GitHub.

    git push origin feature/your-feature-name

  8. Submit a Pull Request: Go to the original repository and submit a pull request. Please provide a clear description of your changes and reference any related issues.

Code Style

Please follow the existing code style and conventions used in the project. Consistency helps maintain readability and ease of maintenance.

Thank You!

We appreciate your contributions and efforts to improve the iEEG Implant Reconstruction Pipeline. If you have any questions, feel free to reach out to the maintainers through the issue tracker.