Skip to content

Commit

Permalink
add releasing guide
Browse files Browse the repository at this point in the history
  • Loading branch information
alex-oleshkevich committed Sep 28, 2023
1 parent 5addac0 commit af1c557
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions .github/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,7 @@ Creating an issue is the simplest form of contributing to a project. But there a
If you'd like to learn more about contributing in general, the [Guide to Idiomatic Contributing](https://github.com/jonschlinkert/idiomatic-contributing) has a lot of useful information.


## Coding

### Code style
## Code style

This project users [pre-commit](https://pre-commit.com/) tool to enforce code style.
You should run it before submitting a pull request. Otherwise, the GitHub action for your PR will fail.
Expand All @@ -38,6 +36,16 @@ pre-commit install
```
Since now every commit will be style-checked.


## Releases

The project use GitHub action to release the library. However, some steps to be performed on the developer's machine.

- edit `pyproject.toml` and bump the version
- commit version change
- assign git tag to the repo, it must be the same as in the `pyproject.toml`: `git tag v1.0.0`
- push changes and tag: `git push && git push --tags`

## Issues

### Before creating an issue
Expand Down

0 comments on commit af1c557

Please sign in to comment.