Skip to content

Commit c2d6e78

Browse files
committed
Add contributing guide and code of conduct documentation
1 parent 157efd6 commit c2d6e78

File tree

3 files changed

+62
-0
lines changed

3 files changed

+62
-0
lines changed

docs/code-of-conduct.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Code of conduct
2+
3+
TODO

docs/contributing.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Contributing
2+
3+
## Run the unit tests
4+
5+
To run the unit tests, you must follow the steps below:
6+
7+
1. Create a virtual environment.
8+
9+
```bash
10+
python -m venv .venv
11+
source .venv/bin/activate
12+
```
13+
14+
2. Install the dependencies.
15+
16+
```bash
17+
pip install -r requirements-dev.txt
18+
```
19+
20+
3. Have a running IRIS instance.
21+
22+
Here you can choose between:
23+
24+
- Local installation of IRIS
25+
- Docker installation of IRIS
26+
27+
### Local installation of IRIS
28+
29+
1. Install IRIS locally.
30+
31+
- [Local installation of IRIS](https://docs.intersystems.com/irislatest/csp/docbook/Doc.View.cls?KEY=PAGE_deployment_install)
32+
- [Python interpreter compatible with the version of IRIS](https://docs.intersystems.com/iris20243/csp/docbook/Doc.View.cls?KEY=GEPYTHON_prereqs#GEPYTHON_prereqs_version)
33+
- [Iris embedded python wrapper](https://github.com/grongierisc/iris-embedded-python-wrapper)
34+
- 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)
35+
36+
37+
2. Then, symbolically this git to the IRIS pyhton directory:
38+
39+
```bash
40+
ln -s <your_git_dir>/src/iop $IRISINSTALLDIR/python/iop
41+
```
42+
43+
3. Run the unit tests.
44+
45+
```bash
46+
pytest
47+
```
48+
49+
### Docker installation of IRIS
50+
51+
No prerequisites are needed. Just run the following command:
52+
53+
```bash
54+
docker build -t pytest-iris -f dockerfile-ci .
55+
docker run -i --rm pytest-iris
56+
```

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ nav:
1616
- Logging: logging.md
1717
- Debugging: debug.md
1818
- Production Settings: prod-settings.md
19+
- Contributing:
20+
- Contributing: contributing.md
21+
- Code of Conduct: code-of-conduct.md
1922
- Reference:
2023
- Examples: example.md
2124
- Useful Links: useful-links.md

0 commit comments

Comments
 (0)