Skip to content

Commit 77b5d78

Browse files
committed
Specialised contribution instructions for dev
1 parent d28f625 commit 77b5d78

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

CONTRIBUTING.md

+40
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,45 @@
11
# Contribution guide for developers
22

3+
## Development
4+
5+
### Setting up the environment
6+
7+
To get started, you will need to setup the development environment. This goes
8+
through two main steps, namely [(1) Installing `pyscript-cli` dependencies](#install-pyscript-cli-dependencies)
9+
and [(2) Installing `pyscript-cli` Dev dependencies](#install-the-development-dependencies).
10+
11+
### Install `pyscript-cli` dependencies
12+
13+
`pyscript-cli` requires [`poetry`](https://python-poetry.org/) to manage dependencies
14+
and setup the environment.
15+
16+
Therefore, the first thing to do is to make sure that you have `poetry` installed
17+
in your current Python environment. Please refer to the official `poetry`
18+
[documentation](https://python-poetry.org/docs/master/#installation) for installation
19+
instructions.
20+
21+
To install `pyscript-cli` dependencies, you will need to run the following command from the project root:
22+
23+
```shell
24+
poetry install
25+
```
26+
27+
### Install the development dependencies
28+
29+
There are a few extra dependencies that are solely required for development.
30+
To install these packages, you will need to run the following command from the project root:
31+
32+
```shell
33+
poetry install --with dev-dependencies
34+
```
35+
36+
Once all the dependencies are installed, you will only need to setup the git hooks
37+
via [`pre-commit`](https://pre-commit.com/):
38+
39+
```shell
40+
pre-commit install
41+
```
42+
343
## Documentation
444

545
### Install the documentation dependencies

0 commit comments

Comments
 (0)