Skip to content

Latest commit

 

History

History
48 lines (31 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 1.48 KB
Raw

How to Contribute

Branch Organization

You can submit all changes to the staging branch, where we do whole our tests for new features

Flags for your branch

To keep the staging branch in a releasable state, breaking changes and experimental features must be gated behind a feature flag.

New Feature

Use this flag to create a branch for new features

  • feature/feature_name

Bug fix

Use this flag to fix some bug

  • bugfix/bug_name

Edit something

Use this flag to edit something

  • edit/edit_name

Your First Pull Request

Working on your first Pull Request? You can learn how from this free video series:

How to Contribute to an Open Source Project on GitHub

Sending a Pull Request

The developers is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.

Before submitting a pull request, please make sure the following is done:

  1. Fork the repository and create your branch from master.

  2. Run poetry install in the repository root.

  3. Make sure your code lints (poetry run flake8).

  4. Make sure your code lints (poetry run black pyypix).

  5. If everything is ready, send your PR to staging branch.

License