Contributing

Contributions to gwtails are welcome! Here’s how you can help:

Reporting Issues

If you find a bug or have a feature request, please open an issue on the GitHub issue tracker.

Development Setup

  1. Fork and clone the repository:

    git clone https://github.com/your-username/gwtails.git
    cd gwtails
    
  2. Install in development mode with documentation dependencies:

    pip install -e ".[docs]"
    
  3. Make your changes and ensure the package still imports correctly:

    python -c "import gwtails; print(gwtails.__version__)"
    
  4. If you modified documentation, build and check it:

    cd docs
    make html
    

Pull Requests

  1. Create a new branch for your feature or fix.

  2. Make your changes with clear commit messages.

  3. Submit a pull request with a description of what you changed and why.

Code Style

  • Follow PEP 8 conventions.

  • Use NumPy-style docstrings for functions and classes.

  • Include type information in docstrings where appropriate.