Skip to content

Latest commit

 

History

History
122 lines (93 loc) · 5.18 KB

CONTRIBUTING.md

File metadata and controls

122 lines (93 loc) · 5.18 KB
Raw

How to contribute

The preferred workflow for contributing to sktime is to fork the main repository on GitHub, clone, and develop on a branch. Steps:

  1. Fork the project repository by clicking on the 'Fork' button near the top right of the page. This creates a copy of the code under your GitHub user account. For more details on how to fork a repository see this guide.

  2. Clone your fork of the sktime repo from your GitHub account to your local disk:

    $ git clone [email protected]:YourLogin/sktime.git
$ cd sktime

  3. Create a new feature branch from the dev branch to hold your changes:

    $ git checkout dev
$ git checkout -b my-feature-branch

    Always use a feature branch. It's good practice to never work on the master branch!

  4. Develop the feature on your feature branch. Add changed files using git add and then git commit files to record your changes in Git:

    $ git add modified_files
$ git commit

  5. When finished, push the changes to your GitHub account with:

    $ git push -u origin my-feature-branch

  6. Follow these instructions to create a pull request from your fork. This will send an email to the committers.

If any of the above seems like magic to you, please look up the Git documentation on the web, or ask a friend or another contributor for help.

Pull Request Checklist

We recommended that your contribution complies with the following rules before you submit a pull request:

  • Follow the PEP8 coding guidelines. A good example can be found here. In addition, we add the following guidelines:

    • Use underscores to separate words in non class names: n_samples rather than nsamples.
    • Avoid multiple statements on one line. Prefer a line return after a control flow statement (if/for).
    • Use relative imports for references inside sktime.
    • Unit tests are an exception to the previous rule; they should use absolute imports, exactly as client code would. A corollary is that, if sktime.foo exports a class or function that is implemented in sktime.foo.bar.baz, the test should import it from sktime.foo.
    • Please don’t use import * in any case. It is considered harmful by the official Python recommendations. It makes the code harder to read as the origin of symbols is no longer explicitly referenced, but most important, it prevents using a static analysis tool like pyflakes to automatically find bugs.
    • Use the numpy docstring standard in all your docstrings.

  • Give your pull request a helpful title that summarises what your contribution does. In some cases Fix <ISSUE TITLE> is enough. Fix #<ISSUE NUMBER> is not enough.

  • Often pull requests resolve one or more other issues (or pull requests). If merging your pull request means that some other issues/PRs should be closed, you should use keywords to create link to them (e.g., Fixes #1234; multiple issues/PRs are allowed as long as each one is preceded by a keyword). Upon merging, those issues/PRs will automatically be closed by GitHub. If your pull request is simply related to some other issues/PRs, create a link to them without using the keywords (e.g., See also #1234).

  • All public methods should have informative docstrings with sample usage presented as doctests when appropriate.

Filing bugs

We use GitHub issues to track all bugs and feature requests; feel free to open an issue if you have found a bug or wish to see a feature implemented.

It is recommended to check that your issue complies with the following rules before submitting:

  • Verify that your issue is not being currently addressed by other issues or pull requests.

  • Please ensure all code snippets and error messages are formatted in appropriate code blocks. See Creating and highlighting code blocks.

  • Please be specific about what estimators and/or functions are involved and the shape of the data, as appropriate; please include a reproducible code snippet or link to a gist. If an exception is raised, please provide the traceback.

Coding tips:

  • When writing new classes, inherit from appropriate base classes (BaseTransformer, BaseClassifier, BaseRegressor),

  • Use relative imports when importing functions or classes from within sktime, except for unit tests where you should use absolute imports.