@@ -12,12 +12,14 @@ To get started, fork the repository to your own github account, then clone it to
12
12
development machine:
13
13
14
14
.. code :: sh
15
+
15
16
git clone [email protected] :your-github-username/< REPO_NAME> .git
16
17
17
18
Next, install the development dependencies. We recommend using a virtual environment,
18
19
such as `virtualenv <https://virtualenv.pypa.io/en/stable/ >`_.
19
20
20
21
.. code :: sh
22
+
21
23
cd < REPO_NAME>
22
24
virtualenv -p python venv
23
25
. venv/bin/activate
@@ -32,6 +34,7 @@ A great way to explore the code base is to run the tests.
32
34
We can run all tests with:
33
35
34
36
.. code :: sh
37
+
35
38
pytest tests
36
39
37
40
Code Style
@@ -42,6 +45,7 @@ the library. This tool runs automatically with every commit, but you can also ru
42
45
manually with:
43
46
44
47
.. code :: sh
48
+
45
49
make lint
46
50
47
51
If you need to make a commit that skips the ``pre-commit `` checks, you can do so with
@@ -91,6 +95,7 @@ Final test before each release
91
95
Before releasing a new version, build and test the package that will be released:
92
96
93
97
.. code :: sh
98
+
94
99
git checkout main && git pull
95
100
make package-test
96
101
@@ -100,6 +105,7 @@ the instructions to activate the venv and test whatever you think is important.
100
105
You can also preview the release notes:
101
106
102
107
.. code :: sh
108
+
103
109
towncrier --draft
104
110
105
111
Build the release notes
@@ -110,6 +116,7 @@ the version to bump (see below), which changes how the version number will show
110
116
release notes.
111
117
112
118
.. code :: sh
119
+
113
120
make notes bump=$$ VERSION_PART_TO_BUMP$$
114
121
115
122
If there are any errors, be sure to re-run make notes until it works.
@@ -120,6 +127,7 @@ Push the release to github & pypi
120
127
After confirming that the release package looks okay, release a new version:
121
128
122
129
.. code :: sh
130
+
123
131
make release bump=$$ VERSION_PART_TO_BUMP$$
124
132
125
133
This command will:
0 commit comments