Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

50 lines (35 loc) · 1.01 KB

CONTRIBUTING

fymail use hatch to manage the project. Please install it before you go ahead. Run command below to install it if you use pip to manage your python packages, or click here for others

pip install hatch

Development

Setup Environment

# create hatch env and install dependence
hatch env create

Lint

hatch fmt

Test

create test environment only once,

hatch env create fymail-test

and run test in the environment

hatch test

Release

  • Update version: hatch version <major|minor|micro|release>, see hatch version for more detail
  • Commit the version change, add new tag and push to remote, and CI will build and publish the package to PyPI
git commit -am "Release version <YOUR_VERSION_HERE>"
git tag <YOUR_VERSION_HERE>
git push origin tag <YOUR_VERSION_HERE>