Skip to content

Commit aaccf08

Browse files
committed
chore: adds contribution guidelines
1 parent faed951 commit aaccf08

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# How to contribute to `validators`
2+
3+
Hi, to start, you need the following installed on your system.
4+
5+
1. [Git](https://git-scm.com/)
6+
2. [Python](https://www.python.org/) v3.8 or later and
7+
3. [PDM](https://pdm-project.org/en/stable/) for easy dependency management.
8+
4. (Optional/Recommended) NodeJS for type checking.
9+
5. (Optional/Recommended) [mise](https://github.com/jdx/mise) to manage multiple versions of Python, NodeJS etc.
10+
11+
12+
First [fork](https://github.com/python-validators/validators/fork) this repository. Then clone it to your system. Then install development dependencies.
13+
14+
15+
```sh
16+
# cloning repository
17+
$ git clone "https://github.com/YOUR_USERNAME/validators.git"
18+
# changing directory
19+
$ cd validators
20+
# installing development dependencies
21+
$ pdm install
22+
```
23+
24+
Activate the virtual environment and run `tox` to verify test cases.
25+
26+
```sh
27+
# activate virtual environment
28+
$ . ./.venv/bin/activate # replace `/bin/` with `/Scripts/` if you're on Windows.
29+
# run tox for linting, type checking, formatting etc.
30+
$ tox
31+
```
32+
33+
Create a git branch. You can now make changes to the source code. If needed, test your change by running `pytest`. Commit, push and create a pull request.
34+
35+
If you're in doubt feel free to start a discussion [here](https://github.com/python-validators/validators/discussions). Thanks for taking interest in this library.

0 commit comments

Comments
 (0)