Skip to content

Commit ec6f301

Browse files
authored
Update CONTRIBUTING.md
1 parent 47af71b commit ec6f301

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed

CONTRIBUTING.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,69 @@ The following contribution information is specific to {project-name}.
1010
[Contributing]: https://dev.docs.pyansys.com/how-to/contributing.html
1111

1212
<!-- Begin content specific to your library here. -->
13+
14+
## Clone the repository
15+
16+
To clone and install the latest *Ansys Tools* release in development mode, run
17+
these commands:
18+
19+
```bash
20+
git clone https://github.com/ansys/ansys-tools-common/
21+
cd ansys-tools
22+
python -m pip install --upgrade pip
23+
pip install -e .
24+
```
25+
26+
## Adhere to code style
27+
28+
*Ansys Tools* follows the PEP8 standard as outlined in PEP 8 in the PyAnsys Developer’s Guide and implements style checking using pre-commit.
29+
30+
To ensure your code meets minimum code styling standards, run these commands:
31+
32+
```bash
33+
pip install pre-commit
34+
pre-commit run --all-files
35+
```
36+
37+
You can also install this as a pre-commit hook by running this command:
38+
39+
```bash
40+
pre-commit install
41+
```
42+
43+
## Run the tests
44+
45+
Prior to running the tests, you must run this command to install the test dependencies:
46+
47+
```bash
48+
pip install -e .[tests]
49+
```
50+
51+
To run the tests, navigate to the root directory of the repository and run this command:
52+
53+
```bash
54+
pytest
55+
```
56+
57+
58+
## Build the documentation
59+
60+
Prior to building the documentation, you must run this command to install the documentation dependencies:
61+
62+
```bash
63+
pip install -e .[doc]
64+
```
65+
66+
To build the documentation, run the following commands:
67+
68+
```bash
69+
cd doc
70+
71+
# On linux
72+
make html
73+
74+
# On windows
75+
./make.bat html
76+
```
77+
78+
The documentation is built in the `docs/_build/html` directory.

0 commit comments

Comments
 (0)