Skip to content

Latest commit

 

History

History
131 lines (101 loc) · 4.78 KB

CONTRIBUTING.md

File metadata and controls

131 lines (101 loc) · 4.78 KB
Raw

Contribution guide

How to start?

Contributing is quite easy: suggest ideas and make them done. We use GitHub issues for bug reports and feature requests.

Every good PR usually consists of:

  • feature implementation :)
  • documentation to describe this feature to other people
  • tests to ensure everything is implemented correctly

Step-by-step guide

Before the PR

Please ensure that you have read the following docs:

Setting up your development environment

Before writing any code it is useful to set up a development environment.

  1. Clone etna library to some folder and go inside:
git clone https://github.com/tinkoff-ai/etna.git etna/
cd etna
  1. Run installation with poetry (poetry installation guide):
poetry install -E all-dev
  1. Activate virtual environment created by poetry:
poetry shell

To connect virtual environment interpreter to IDE use which python command.

New feature

  1. Make an issue with your feature description;
  2. We shall discuss the design and its implementation details;
  3. Once we agree that the plan looks good, go ahead and implement it.

Bugfix

  1. Goto GitHub issues;
  2. Pick an issue and comment on the task that you want to work on this feature;
  3. If you need more context on a specific issue, please ask, and we will discuss the details.

You can also join our ETNA Community telegram chat to make it easier to discuss. Once you finish implementing a feature or bugfix, please send a Pull Request.

If you are not familiar with creating a Pull Request, here are some guides:

Tests

Do not forget to check that your code passes the unit tests.

poetry install -E tests

pytest tests -v
pytest etna -v --doctest-modules

ETNA uses the black and flake8 with several plugins for coding style checks as well as mypy for type checks, and you must ensure that your code follows it.

poetry install -E style

make format

If any of checks fails, the CI will fail and your Pull Request won't be merged.

Documentation

ETNA uses Numpydoc style for formatting docstrings. The documentation is written in ReST. Length of a line inside docstrings block must be limited to 100 characters to fit into Jupyter documentation popups.

You could check the docs with:

cp examples/*.ipynb docs/source/tutorials
cd docs
make clean
make html

Now you could open them into your browser, for example with

open ./build/html/index.html

If you have some issues with building docs - please make sure that you installed the required packages.

poetry install -E docs

You also may need to install pandoc package (pandoc installation guide):

# Ubuntu
apt-get update && apt-get install -y pandoc

# Mac OS
brew install pandoc

#Windows
choco install pandoc

During creation of Pull Request make sure that your documentation looks good, check:

  1. Parameters and Returns sections have correct names and types;
  2. Sections should be
    1. divided correctly without artefacts,
    2. consistent by meaning with Numpydoc Style Guide;
  3. Lists are rendered correctly;
  4. Listings of code, e.g. variable names, are typed with monospaced font;
  5. Mathematical formulas are rendered correctly;
  6. Links to external sources are active;
  7. References to python objects should be active if library is listed in intersphinx_mapping

Useful links:

  1. ReST Quickref
  2. ReST Roles
  3. ReST Cross-referencing Python objects
  4. Matplotlib Cheetsheet
  5. Sklearn example