| 1 | # Contributing to express-validator
|
| 2 | Hey! We are glad you want to help us improve express-validator.
|
| 3 |
|
| 4 | 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.
|
| 5 | It's a short read and will get you started on how most things work.
|
| 6 |
|
| 7 | ## Issues
|
| 8 | In case you are having issues while using express-validator, make sure to browse through the project's issues before opening a new one.
|
| 9 | Someone else may have had the same problem before.
|
| 10 |
|
| 11 | 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.
|
| 12 | Every detail you can give will be of great help.
|
| 13 |
|
| 14 | ## Pull Requests
|
| 15 | Do you ant to dedicate your time to help improve the codebase? Great! Then submitting a pull request is the best way to do this.
|
| 16 |
|
| 17 | In case you opened a issue, then fixing it yourself is the fastest way to get it done.
|
| 18 | Otherwise, feel free to browse through the open issues and find some ideas on what needs some implementation.
|
| 19 |
|
| 20 | We have some requirements regarding pull requests:
|
| 21 | - **Every pull request must include tests!**
|
| 22 | - **The builds must pass**; if they don't, click through, find out why, and fix it.
|
| 23 | - If you're adding/changing functionality, make sure to reflect the changes in the readme file.
|
| 24 |
|
| 25 | ---
|
| 26 |
|
| 27 | Finally, remember: **this is an open source project. We contribute whenever our time allows us.**
|