Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 934 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 934 Bytes
Raw

Contributing

All kinds of contributions are welcome, including but not limited to the following.

  • Fix typo or bugs
  • Add documentation or translate the documentation into other languages
  • Add new features and components

Workflow

  1. fork and pull the latest repository
  2. checkout a new branch (do not use master branch for PRs)
  3. commit your changes
  4. create a PR

Note: If you plan to add some new features that involve large changes, it is encouraged to open an issue for discussion first.

Code style

Python

We adopt PEP8 as the preferred code style.

We use the following tools for linting and formatting:

  • flake8: A wrapper around some linter tools.
  • isort: A Python utility to sort imports.

Before you create a PR, make sure that your code lints and is formatted by black.