Skip to content

Commit eacccaf

Browse files
authored
docs: move contributing guidelines to CONTRIBUTING.md (validatorjs#2386)
1 parent d8c93d2 commit eacccaf

File tree

2 files changed

+37
-37
lines changed

2 files changed

+37
-37
lines changed

CONTRIBUTING.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to validator.js
2+
Welcome to validator.js repository!! We appreciate your interest in contributing to this open library and for helping our community grow.
3+
4+
## How to Contribute
5+
### Code Contribution
6+
In general, we follow the "fork-and-pull" Git workflow.
7+
8+
1. [Fork](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project) the repository on GitHub
9+
2. Clone the project to your local machine
10+
3. Work on your fork
11+
* Make your changes and additions
12+
- Most of your changes should be focused on src/ and test/ folders and/or [README.md](https://github.com/validatorjs/validator.js/blob/master/README.md).
13+
- Files such as validator.js, validator.min.js and files in lib/ folder are autogenerated when running tests (npm test) and need not to be changed **manually**.
14+
* Change or add tests if needed
15+
* Run tests and make sure they pass
16+
* Add changes to README.md if needed
17+
4. Commit changes to your own branch
18+
5. **Make sure** you merge the latest from "upstream" and resolve conflicts if there is any
19+
6. Repeat step 3(3) above
20+
7. Push your work back up to your fork
21+
8. Submit a Pull request so that we can review your changes
22+
23+
#### Run Tests
24+
Tests are using mocha. To run the tests use:
25+
26+
```sh
27+
$ npm test
28+
```
29+
30+
### Financial Contribution
31+
We welcome financial contributions on our [open collective](https://opencollective.com/validatorjs).
32+
33+
You can opt to become a [backer](https://opencollective.com/validatorjs#backer) or a [sponsor](https://opencollective.com/validatorjs#sponsor) and help our project sustain over time.
34+
35+
Thank you to the people who have already contributed:
36+
37+
<a href="https://github.com/validatorjs/validator.js/graphs/contributors"><img src="https://opencollective.com/validatorjs/contributors.svg?width=890" /></a>

README.md

-37
Original file line numberDiff line numberDiff line change
@@ -72,16 +72,6 @@ CDN
7272
<script src="https://unpkg.com/validator@latest/validator.min.js"></script>
7373
```
7474

75-
## Contributors
76-
77-
[Become a backer](https://opencollective.com/validatorjs#backer)
78-
79-
[Become a sponsor](https://opencollective.com/validatorjs#sponsor)
80-
81-
Thank you to the people who have already contributed:
82-
83-
<a href="https://github.com/validatorjs/validator.js/graphs/contributors"><img src="https://opencollective.com/validatorjs/contributors.svg?width=890" /></a>
84-
8575
## Validators
8676

8777
Here is a list of the validators currently available.
@@ -202,33 +192,6 @@ XSS sanitization was removed from the library in [2d5d6999](https://github.com/v
202192

203193
For an alternative, have a look at Yahoo's [xss-filters library](https://github.com/yahoo/xss-filters) or at [DOMPurify](https://github.com/cure53/DOMPurify).
204194

205-
## Contributing
206-
207-
In general, we follow the "fork-and-pull" Git workflow.
208-
209-
1. Fork the repo on GitHub
210-
2. Clone the project to your own machine
211-
3. Work on your fork
212-
1. Make your changes and additions
213-
- Most of your changes should be focused on `src/` and `test/` folders and/or `README.md`.
214-
- Files such as `validator.js`, `validator.min.js` and files in `lib/` folder are autogenerated when running tests (`npm test`) and need not to be changed **manually**.
215-
2. Change or add tests if needed
216-
3. Run tests and make sure they pass
217-
4. Add changes to README.md if needed
218-
4. Commit changes to your own branch
219-
5. **Make sure** you merge the latest from "upstream" and resolve conflicts if there is any
220-
6. Repeat step 3(3) above
221-
7. Push your work back up to your fork
222-
8. Submit a Pull request so that we can review your changes
223-
224-
## Tests
225-
226-
Tests are using mocha, to run the tests use:
227-
228-
```sh
229-
$ npm test
230-
```
231-
232195
## Maintainers
233196

234197
- [chriso](https://github.com/chriso) - **Chris O'Hara** (author)

0 commit comments

Comments
 (0)