From 4cc133a2459ba31ee3915e7a3d4fbd340cc4d16f Mon Sep 17 00:00:00 2001 From: alinaghale88 Date: Sun, 31 Mar 2024 15:11:54 -0700 Subject: [PATCH 1/4] Create CONTRIBUTING.md file --- CONTRIBUTING.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..e69de29bb From 784130b4d80072bacabb6fae128b5b7841a87e91 Mon Sep 17 00:00:00 2001 From: alinaghale88 Date: Sun, 31 Mar 2024 16:16:40 -0700 Subject: [PATCH 2/4] Add contributing guidelines to CONTRIBUTING.md --- CONTRIBUTING.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69de29bb..419d35b40 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -0,0 +1,37 @@ +# Contributing to validator.js +Welcome to validator.js repository!! We appreciate your interest in contributing to this open library and for helping our community grow. + +## How to Contribute +### Code Contribution +In general, we follow the "fork-and-pull" Git workflow. + +1. Fork the repository on GitHub +2. Clone the project to your local machine +3. Work on your fork + * Make your changes and additions + - Most of your changes should be focused on src/ and test/ folders and/or README.md. + - 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**. + * Change or add tests if needed + * Run tests and make sure they pass + * Add changes to README.md if needed +4. Commit changes to your own branch +5. **Make sure** you merge the latest from "upstream" and resolve conflicts if there is any +6. Repeat step 3(3) above +7. Push your work back up to your fork +8. Submit a Pull request so that we can review your changes + +#### Run Tests +Tests are using mocha. To run the tests use: + +```sh +$ npm test +``` + +### Financial Contribution +We welcome financial contributions on our [open collective](https://opencollective.com/validatorjs). + +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. + +Thank you to the people who have already contributed: + + \ No newline at end of file From d5bf33a64b9116b22912a99b581098ff456d9ee0 Mon Sep 17 00:00:00 2001 From: alinaghale88 Date: Sun, 31 Mar 2024 16:33:54 -0700 Subject: [PATCH 3/4] Remove Contributing info from README.md --- README.md | 37 ------------------------------------- 1 file changed, 37 deletions(-) diff --git a/README.md b/README.md index 4dfd259a9..2583a20c9 100644 --- a/README.md +++ b/README.md @@ -72,16 +72,6 @@ CDN ``` -## Contributors - -[Become a backer](https://opencollective.com/validatorjs#backer) - -[Become a sponsor](https://opencollective.com/validatorjs#sponsor) - -Thank you to the people who have already contributed: - - - ## Validators Here is a list of the validators currently available. @@ -201,33 +191,6 @@ XSS sanitization was removed from the library in [2d5d6999](https://github.com/v 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). -## Contributing - -In general, we follow the "fork-and-pull" Git workflow. - -1. Fork the repo on GitHub -2. Clone the project to your own machine -3. Work on your fork - 1. Make your changes and additions - - Most of your changes should be focused on `src/` and `test/` folders and/or `README.md`. - - 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**. - 2. Change or add tests if needed - 3. Run tests and make sure they pass - 4. Add changes to README.md if needed -4. Commit changes to your own branch -5. **Make sure** you merge the latest from "upstream" and resolve conflicts if there is any -6. Repeat step 3(3) above -7. Push your work back up to your fork -8. Submit a Pull request so that we can review your changes - -## Tests - -Tests are using mocha, to run the tests use: - -```sh -$ npm test -``` - ## Maintainers - [chriso](https://github.com/chriso) - **Chris O'Hara** (author) From 95d081bae756a2efdb97904c2f9f524efa606caf Mon Sep 17 00:00:00 2001 From: alinaghale88 Date: Sun, 31 Mar 2024 16:37:33 -0700 Subject: [PATCH 4/4] Add useful links in CONTRIBUTING.md file --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 419d35b40..c7da04163 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,11 +5,11 @@ Welcome to validator.js repository!! We appreciate your interest in contributing ### Code Contribution In general, we follow the "fork-and-pull" Git workflow. -1. Fork the repository on GitHub +1. [Fork](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project) the repository on GitHub 2. Clone the project to your local machine 3. Work on your fork * Make your changes and additions - - Most of your changes should be focused on src/ and test/ folders and/or README.md. + - 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). - 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**. * Change or add tests if needed * Run tests and make sure they pass