Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (25 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

36 lines (25 loc) · 1 KB
Raw

Contributing to TFTS

If you are interested in contributing to tfts,

  • Feel free to send a Pull Request
  • If you want to implement a new feature and unsure about it, you can post an issue first

Once you finish implementing a feature a bug-fix, please send a Pull Request to https://github.com/LongxingTan/Time-series-prediction

Developing TFTS

Install uv and create the locked development environment:

uv sync --group docs
uv run pre-commit install

Before submitting a change, run the same checks used by CI:

make style
make test
make docs

To develop tfts on your machine, follow these guidelines:

  1. Uninstall existing tfts installations:
  2. Clone a copy of tfts from source
  3. Create a new branch and edit the code
  4. Install pre-commit hooks
  5. Ensure your code is formatted correctly by testing against the styleguide of flake8
  6. Ensure the entire test suite passed and the code coverage roughly stays the same
  7. Update and test the documentation