Skip to content

Commit 96bbc85

Browse files
committed
Enhance contributing guide formatting for improved clarity on setup instructions
1 parent 6f422ef commit 96bbc85

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

docs/contributing.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,51 @@
44

55
To run the unit tests, you must follow the steps below:
66

7-
1. Create a virtual environment.
7+
### Create a virtual environment.
88

99
```bash
1010
python -m venv .venv
1111
source .venv/bin/activate
1212
```
1313

14-
2. Install the dependencies.
14+
### Install the dependencies.
1515

1616
```bash
1717
pip install -r requirements-dev.txt
1818
```
1919

20-
3. Have a running IRIS instance.
20+
### Have a running IRIS instance.
2121

2222
Here you can choose between:
2323

2424
- Local installation of IRIS
2525
- Docker installation of IRIS
2626

27-
### Local installation of IRIS
27+
#### Local installation of IRIS
2828

29-
1. Install IRIS locally.
29+
##### Install IRIS locally.
3030

3131
- [Local installation of IRIS](https://docs.intersystems.com/irislatest/csp/docbook/Doc.View.cls?KEY=PAGE_deployment_install)
3232
- [Python interpreter compatible with the version of IRIS](https://docs.intersystems.com/iris20243/csp/docbook/Doc.View.cls?KEY=GEPYTHON_prereqs#GEPYTHON_prereqs_version)
3333
- [Iris embedded python wrapper](https://github.com/grongierisc/iris-embedded-python-wrapper)
3434
- Make sure to follow the [instructions to install the wrapper in your IRIS instance.](https://github.com/grongierisc/iris-embedded-python-wrapper?tab=readme-ov-file#pre-requisites)
3535

3636

37-
2. Then, symbolically this git to the IRIS pyhton directory:
37+
##### Set up the IRIS instance.
38+
39+
Then, symbolically this git to the IRIS pyhton directory:
3840

3941
```bash
4042
ln -s <your_git_dir>/src/iop $IRISINSTALLDIR/python/iop
4143
```
4244

43-
3. Run the unit tests.
45+
##### Run the unit tests.
4446

4547
```bash
4648
pytest
4749
```
4850

49-
### Docker installation of IRIS
51+
#### Docker installation of IRIS
5052

5153
No prerequisites are needed. Just run the following command:
5254

0 commit comments

Comments
 (0)