You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,15 @@ Python 3.8 and above are supported by the SDK.
12
12
13
13
### Installation and Dependencies
14
14
15
-
A [`Makefile`](./Makefile) has been included in the project which should make it straightforward to start the project locally. We utilize virtual environments (see [`virtualenv`](https://docs.python.org/3/tutorial/venv.html)) in order to provide isolated development environments for the project. This reduces the risk of invalid or corrupt global packages. It also integrates nicely with Make, which will detect changes in the `requirements.txt` file and update the virtual environment if any occur.
15
+
We use [Hatch](https://hatch.pypa.io/)to manage the project. Hatch is does not have built-in support for monorepos yet, so you must run it inside each package directory.
16
16
17
-
Run `make init` to initialize the project's virtual environment and install all dev dependencies.
17
+
To install Hatch, just run `pip install hatch`.
18
+
19
+
You will also need to setup the `pre-commit` hooks. Run `pre-commit install` in the root directory of the repository. If you don't have `pre-commit` installed, you can install it with `pip install pre-commit`.
18
20
19
21
### Testing
20
22
21
-
Run tests with `make test`.
23
+
Run tests by entering the package directory and running `hatch run test`.
22
24
23
25
We use `pytest` for our unit testing, making use of `parametrized` to inject cases at scale.
24
26
@@ -28,7 +30,10 @@ These are planned once the SDK has been stabilized and a Flagd provider implemen
28
30
29
31
### Packaging
30
32
31
-
We publish to the PyPI repository, where you can find this package at [openfeature-sdk-contrib](https://pypi.org/project/openfeature-sdk-contrib/).
33
+
We publish to the PyPI repository, where you can find each individual package:
0 commit comments