Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
113 lines (82 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

113 lines (82 loc) · 3.76 KB

How to contribute

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
  • Be sure to add the complete error messages.

Do you have a feature request?

  • Ensure that it hasn't been yet implemented in the main branch of the repository and that there's not an Issue requesting it yet.
  • Open a new issue and make sure to describe it clearly, mention how it improves the project and why its useful.

Do you want to fix a bug or implement a feature?

Bug fixes and features are added through pull requests (PRs).

PR submission guidelines

  • Keep each PR focused. While it's more convenient, do not combine several unrelated fixes together. Create as many branches as needing to keep each PR focused.
  • Ensure that your PR includes a test that fails without your patch, and passes with it.
  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
  • Do not mix style changes/fixes with "functional" changes. It's very difficult to review such PRs and it most likely get rejected.
  • Do not add/remove vertical whitespace. Preserve the original style of the file you edit as much as you can.
  • Do not turn an already submitted PR into your development playground. If after you submitted PR, you discovered that more work is needed - close the PR, do the required work and then submit a new PR. Otherwise each of your commits requires attention from maintainers of the project.
  • If, however, you submitted a PR and received a request for changes, you should proceed with commits inside that PR, so that the maintainer can see the incremental fixes and won't need to review the whole PR again. In the exception case where you realize it'll take many many commits to complete the requests, then it's probably best to close the PR, do the work and then submit it again. Use common sense where you'd choose one way over another.

Local setup for working on a PR

Clone the repository

  • HTTPS: git clone https://github.com/Nixtla/utilsforecast.git
  • SSH: git clone git@github.com:Nixtla/utilsforecast.git
  • GitHub CLI: gh repo clone Nixtla/utilsforecast

🛠️ Create the Development Environment

pip install uv
uv venv --python 3.10
source .venv/bin/activate

# Install the library in editable mode for development
uv pip install -e ".[dev]" -U

🔧 Install Pre-commit Hooks

Pre-commit hooks help maintain code quality by running checks before commits. 🛡️

pre-commit install
pre-commit run --all-files

Viewing documentation locally

The new documentation pipeline relies on mintlify and lazydocs.

install mintlify

Note

Please install Node.js before proceeding.

npm i -g mint

For additional instructions, you can read about it here.

make all_docs

Finally to view the documentation

make preview_docs

Running tests

If you're working on the local interface you can just use

uv run pytest

Do you want to contribute to the documentation?

  • The docs are automatically generated from the docstrings in the utilsforecast folder.
  • To contribute, ensure your docstrings follow the Google style format.
  • Once your docstring is correctly written, the documentation framework will scrape it and regenerate the corresponding .mdx files and your changes will then appear in the updated docs.
  • Make an appropriate entry in the docs/mintlify/mint.json file.