Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
117 lines (74 loc) · 2.02 KB

CONTRIBUTING.md

File metadata and controls

117 lines (74 loc) · 2.02 KB

Contributing to TranCIT: Transient Causal Interaction

Thank you for considering contributing to the TranCIT project! Your help is highly appreciated and essential for improving this package.

Whether you're reporting bugs, suggesting features, improving documentation, or submitting code — you're welcome!

📦 Project Structure

The main code is organized under:

    trancit/

Docs are under:

    docs/

Tests are typically under:

    tests/

Setup Instructions

  1. Clone the repository:

    git clone https://github.com/CMC-lab/TranCIT
cd TranCIT

  2. Create a virtual environment:

    python -m venv trancit_env
source trancit_env/bin/activate

  3. Install the package (editable mode) with dev dependencies:

    pip install -e ".[dev]"

  4. Run tests:

    pytest

Making a Contribution

Bug Reports or Feature Requests

  • Use the GitHub Issues section.
  • Please provide a clear description and, if possible, steps to reproduce the issue.

Code Contributions

  • Fork the repo
  • Create a feature or bugfix branch: git checkout -b fix/some-issue
  • Write tests if necessary
  • Run tests and linters locally before pushing
  • Open a pull request (PR) against main with a meaningful description

Style Guide

  • Follow flake8 for Python code.
  • Docstrings use Google-style or NumPy-style (keep it consistent).
  • Run black or ruff to auto-format.
  • Type annotations are strongly encouraged.

Testing

We use pytest for testing. Make sure your contributions include tests and that existing tests pass:

pytest

📚 Documentation

The documentation lives in the docs/ folder and uses Sphinx.

To build locally:

cd docs
make html

License

This project uses the BSD-2-Clause License. See LICENSE for more details.

Thanks again for helping improve TranCIT! 🙏