Skip to content

Commit a1ba069

Browse files
committed
docs: Describe basic contributor workflow
1 parent 84290e4 commit a1ba069

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

DEVELOP.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
2+
# How to contribute
3+
4+
5+
## Installation
6+
7+
Checkout the latest master.
8+
9+
git clone https://github.com/florisla/stm32loader.git
10+
11+
Install in editable mode with development tools (preferable in a virtual
12+
environment).
13+
14+
python -m venv .venv
15+
.\.venv\bin\activate
16+
pip uninstall stm32loader
17+
pip install --editable .[dev]
18+
19+
20+
## Testing
21+
22+
Run pytest.
23+
24+
pytest .
25+
26+
27+
## Linting
28+
29+
Run flake8, pylint and black.
30+
31+
flake8 stm32loader
32+
pylint stm32loader
33+
black --check stm32loader
34+
35+
36+
## Commit messages
37+
38+
I try to follow the 'conventional commits' commit message style;
39+
see https://www.conventionalcommits.org/ .
40+
41+
42+
## Bump the version number
43+
44+
bumpversion --new-version 1.0.8-dev bogus-part
45+
46+
47+
## Tag a release
48+
49+
First, bump the version number to a release version.
50+
Then create the git tag.
51+
52+
git tag -a "v1.0.9" -m "release: Tag version v1.0.9"
53+
54+
Also push it to upstream.
55+
56+
git push origin v1.0.9

0 commit comments

Comments
 (0)