Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
49 lines (32 loc) · 1.6 KB

CONTRIBUTING.md

File metadata and controls

49 lines (32 loc) · 1.6 KB

Contributing to WaveSpace

Thank you for your interest in contributing to WaveSpace, a Python package for analyzing cortical traveling waves. We welcome contributions from the community to improve and expand the project.

Repository: WaveSpace on GitHub

How to Contribute

  1. Contact If you have questions or want to discuss potential contributions, please reach out to Kirsten Petras via GitHub.

  2. Fork and Branch

    • Fork the repository to your own GitHub account.

    • Create a new branch for your feature or bugfix:

      git checkout -b feature/your-feature-name

  3. Make Your Changes

    • Keep changes focused and concise.
    • Follow existing code style and structure where possible.
    • Add or update documentation as needed.

  4. Testing

    • Ensure that all unit tests pass before submitting.

    • Contributions will only be accepted if the test suite runs successfully.

    • Run tests locally using Python's built-in unittest framework from the UnitTest folder:

      python -m unittest discover UnitTest

  5. Pull Request

    • Push your branch to your forked repository.
    • Open a pull request (PR) to the main branch of WaveSpace.
    • Clearly describe your changes and reference related issues if applicable.

Contribution Guidelines

  • Be respectful and collaborative in discussions.
  • Write clean, well-documented code.
  • Small, focused contributions are preferred over large, unfocused changes.

We appreciate your efforts to help improve WaveSpace!