Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.43 KB
Raw

Contributing

Contributing to code

Local development

You will first need to clone the repository using git and place yourself in its directory:

git clone git@github.com:timzatko/Sklearn-Nature-Inspired-Search.git
cd Sklearn-Nature-Inspired-Search

You need to install Poetry on your local machine. They execute the following commands within the project directory. Make sure that the tests are passing on your machine.

poetry install
poetry run python -m unittest tests

You can also run tests with test coverage and then print out the report.

poetry run coverage run --source=./sklearn_nature_inspired_algorithms -m unittest tests
poetry run coverage report -m

Branching strategy

This repository follows trunk based development branching strategy. You can read more about it here.

Releasing

Use semantic versioning for versions.

Bump version

  1. Bump version with 
    sh ./version.sh v0.1.1
  2. Push the created commit and a tag 
    git push --tags
    This will trigger a pipeline which will make a draft release.
  3. Publish the draft release, don't forget to edit release notes. Publishing the release will trigger the release pipeline which will publish the package to the pypi registry.