@@ -48,7 +48,15 @@ contributing to the repo.
4848
4949## Prerequisites
5050
51- ### It is recommended to use a virtual environment
51+ ### Clone repo
52+
53+ ``` console
54+ git clone https://github.com/[ORG NAME]/[REPO NAME]
55+
56+ cd [REPO NAME]
57+ ```
58+
59+ ### Virtual Environment
5260
5361Use a ([ ` venv ` ] ( https://docs.python.org/3/library/venv.html ) ), or equivalent,
5462when working with python projects. Leveraging a ` venv ` will ensure the installed
@@ -90,25 +98,17 @@ To deactivate (exit) the `venv`:
9098deactivate
9199```
92100
93-
94101---
95102
96103## Developer Installation Steps
97104
98- Clone this repo and enter root directory of repo:
99-
100- ``` console
101- git clone https://github.com/[ORG NAME]/[REPO NAME]
102- cd [REPO NAME]
103- ```
104-
105- Install editable library and development requirements:
105+ ### Install editable library and development requirements
106106
107107``` console
108108python -m pip install --editable .[dev,test]
109109```
110110
111- Install pre-commit [ (see below for details)] ( #pre-commit ) :
111+ ### Install pre-commit [ (see below for details)] ( #pre-commit )
112112
113113``` console
114114pre-commit install
@@ -118,25 +118,25 @@ pre-commit install
118118
119119## Pre-commit and nox tools
120120
121- Run pre-commit on all files:
121+ ### Run pre-commit on all files
122122
123123``` console
124124pre-commit run --all-files
125125```
126126
127- Run tests with coverage (quick):
127+ ### Run tests with coverage (quick)
128128
129129``` console
130130nox -e coverage
131131```
132132
133- Run tests (slow):
133+ ### Run tests (slow)
134134
135135``` console
136136nox
137137```
138138
139- Build dist:
139+ ### Build dist
140140
141141``` console
142142nox -e build
@@ -153,13 +153,13 @@ generated `requirements-*.txt` files.
153153
154154Once updated following the steps below, the package can be installed if needed.
155155
156- To update the generated files with a dependency:
156+ ### Update the generated files with changes
157157
158158``` console
159159nox -e update
160160```
161161
162- To attempt to upgrade all generated dependencies:
162+ ### Upgrade all generated dependencies
163163
164164``` console
165165nox -e upgrade
@@ -176,6 +176,6 @@ any code submitted for review already passes all selected pre-commit checks.
176176
177177---
178178
179- ## Error: File "setup.py" not found.
179+ ## Error: File "setup.py" not found
180180
181181Update ` pip ` to at least version 22.3.1
0 commit comments