Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (27 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

42 lines (27 loc) · 1.15 KB
Raw

Contributing

Thank you for having interest in contributing this project!

Bugs

Please create an issue or pull request.

Proposing a Change

I recommend to create an issue.

Developing

  • The development branch is develop.
  • All pull requests should be opened against develop.
  • The changes on the develop branch are published to Test PyPI .
    • You can install the develop package by executing pip install -i https://test.pypi.org/simple/ autoload-module .

To develop locally:

  1. Install poetry .
  2. Clone this repository.
  3. Create a new branch.
  4. Install the dependencies with: poetry install --all-extras
  5. Enable pre-commit .

Testing

  • Please update the tests to reflect your code changes.
  • Pull requests will not be accepted if they are failing on GitHub Actions.
  • You can also check your code by executing poetry run pytest .

Docs

I'm not familiar with English, so I especially thank you for documents' corrections.

Release

I release autoload-module by merging from develop into master branch.