Skip to content

Commit 26b16c3

Browse files
Readme update
1 parent 10ad575 commit 26b16c3

File tree

2 files changed

+41
-1
lines changed

2 files changed

+41
-1
lines changed

CONTRIBUTING.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Contributing to param-validator
2+
3+
Hey! We are glad you want to help us improve express-validator.
4+
5+
Even though we will appreciate any contribution, please make sure to read [this guide](https://guides.github.com/activities/contributing-to-open-source/) on how to contribute on GitHub.
6+
It's a short read and will get you started on how most things work.
7+
8+
## Issues
9+
10+
In case you are having issues while using express-validator, make sure to browse through the project's issues before opening a new one.
11+
Someone else may have had the same problem before.
12+
13+
When opening a new issue, please provide us some code that reproduces the errors you're getting, perhaps some logs too, express-validator version, etc.
14+
Every detail you can give will be of great help.
15+
16+
## Pull Requests
17+
18+
Do you want to dedicate your time to help improve the codebase? Great! Then submitting a pull request is the best way to do this.
19+
20+
If you are a new contributor and you want to improve the codebase you can follow these five steps:
21+
22+
1. Fork the repository.
23+
2. Choose an issue to work on.
24+
3. Work on the issue locally.
25+
4. Push to your fork.
26+
5. Open a Pull Request.
27+
28+
In case you opened a issue, then fixing it yourself is the fastest way to get it done.
29+
Otherwise, feel free to browse through the open issues and find some ideas on what needs some implementation.
30+
31+
We have some requirements regarding pull requests:
32+
33+
- Every pull request should include tests.
34+
- **The builds must pass**; if they don't, click through, find out why, and fix it.
35+
- If you're adding/changing functionality, make sure to reflect the changes in the readme file.
36+
37+
---
38+
39+
Finally, remember: **this is an open source project. We contribute whenever our time allows us.**

jestconfig.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
"^.+\\.(t|j)sx?$": "ts-jest"
44
},
55
"testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
6-
"moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
6+
"moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
7+
"modulePathIgnorePatterns": ["lib"]
78
}

0 commit comments

Comments
 (0)