88 <a href =" https://github.com/psf/black " ><img src =" https://img.shields.io/badge/code%20style-black-000000.svg " alt =" Code style: black " height =" 18 " ></a >
99</p >
1010
11-
1211# Install
1312
1413To install
@@ -28,6 +27,7 @@ gitcommit
2827The purpose of this utility is to expedite the process of committing with a conventional message format in a user friendly way. This tool is not templated, because it sticks rigidly to the [ Conventional Commit standard] ( https://www.conventionalcommits.org ) , and thus not designed to be 'altered' on a case by case basis.
2928
3029Commit messages produced follow the general template:
30+
3131```
3232<type>[(optional scope)]: <description>
3333
@@ -47,7 +47,7 @@ Additional rules implemeted:
4747The old distribution method is documented in
4848[ docs/dev_distibution_legacy.md] ( docs/dev_distribution_legacy.md )
4949
50- * Note : if modifying ` .travis.yml ` you should verify it by running ` travis lint .travis.yml ` *
50+ _ Note : if modifying ` .travis.yml ` you should verify it by running ` travis lint .travis.yml ` _
5151
5252## Getting started
5353
@@ -62,33 +62,35 @@ The old distribution method is documented in
62621 . ` pre-commit install `
6363
64641 . It is highly recommend you enable setting for storing the venvs within your projects.
65- ```
66- poetry config settings.virtualenvs.in-project true
67- ```
65+
66+ ```
67+ poetry config virtualenvs.in-project true
68+ ```
6869
69701 . Install project dependencies.
70- ```
71- poetry install
72- ```
71+ ```
72+ poetry install
73+ ```
7374
7475## Running the package locally
7576
76771 . Activate the virtual environment.
77- ```
78- source .venv/bin/activate
79- ```
78+
79+ ```
80+ source .venv/bin/activate
81+ ```
8082
81831 . Run the package as a module.
82- ```
83- python -m gitcommit
84- ```
84+ ```
85+ python -m gitcommit
86+ ```
8587
8688Alternatively,
8789
88901 . Run the package using Poetry's venv as context
89- ```
90- poetry run python -m gitcommit
91- ```
91+ ```
92+ poetry run python -m gitcommit
93+ ```
9294
9395Or, if in another directory,
9496
@@ -99,17 +101,22 @@ Or, if in another directory,
99101## Deploy
100102
101103Deployment is handled automatically by Travis CI. It has been linked to the
102- repository and is automatically watching for pushes to master. It will build and
103- test every commit to master. It will also build every tagged commit as if it was
104- a branch, and since its a tagged commit, will attempt to publish it to PyPI.
104+ repository and is automatically watching for pushes to master. It will build
105+ and test every commit to master. It will also build every tagged commit as
106+ if it was a branch, and since its a tagged commit, will attempt to publish
107+ it to PyPI.
105108
1061091. Don't forget to increment version number set in `pyproject.toml`. This can be
107110 done with poetry.
111+
108112 ```
109113 poetry version [ patch|minor|major]
110114 ```
111115
116+ 1. Update the version number as stored in the `gitcommit/__version__.py` file to match that designated by Poetry.
117+
1121181. Tag the commit (by default applies to HEAD commit - make sure you are on the latest `develop` commit).
119+
113120 ```
114121 git tag v#.#.#
115122 ```
0 commit comments