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
For any kind of issue (**bug** report, **feature** request, **question**) feel free to **open an issue**. Before creating an issue search for related issues to prevent **duplicates**.
3
2
4
-
## Contributing Code
5
-
- Fork this repository
6
-
- Create a **topic branch** with a short and describing name for your contribution
7
-
- Add code to your branch
8
-
- Create a **Pull Request**
3
+
## Setup
9
4
10
-
Please refer to any related issues in your Pull Request. For bigger changes you should first create an issue.
5
+
Django Ninja API key uses Flit to build, package and publish the project.
6
+
7
+
It's recommended to create and activate an virtual environment before installing the project. Simply run
8
+
```
9
+
python -m venv .venv
10
+
```
11
+
and activate the environment with
12
+
```
13
+
source .venv/bin/activate
14
+
```
15
+
Now install flit:
16
+
```
17
+
pip install flit
18
+
```
19
+
Now you are ready to install the project:
20
+
```
21
+
make install
22
+
```
23
+
Once you're you can check if all works with
24
+
```
25
+
make test
26
+
```
27
+
28
+
## Tests
29
+
Please make sure to write tests for your changes. You can run the tests with
30
+
```
31
+
make test
32
+
```
33
+
Also make sure the test coverage did not suffer with your contribution:
0 commit comments