Contributing

Thank you for your interest in contributing to Validation Box! Whether you’re fixing bugs, adding new features, improving documentation, or suggesting ideas, your contributions make a difference.

How to Contribute

Following these steps helps keep Validation Box stable and easy to maintain for everyone.

Contributing to Validation Box is easy! Follow these steps to get started:

Fork & Clone the Repository

Before making any changes, you need to fork the repository on GitHub and clone it locally. This allows you to work on the codebase without affecting the main project.

git clone https://github.com/euotiniel/validation-box.git
 
cd validation-box

Install Dependencies

Validation Box is designed to be lightweight and dependency-free for users, but for development, we use a few tools. To get started, install the necessary dependencies:

npm install

This will set up the project environment so you can start coding.

Make Your Changes

There are multiple ways to contribute:

Fix Bugs – Identify and resolve existing issues.
Add New Validation Methods – Improve the library with new functionality.
Enhance Performance – Optimize regex, execution time, or structure.
Improve Documentation – Make it clearer and more user-friendly.

If you're adding a new feature, please open a GitHub issue or discussion first to ensure it aligns with the project’s goal.

Running & Testing Your Code

Before submitting your changes, you should test them to ensure everything is working as expected.

Validation Box includes automated tests to maintain stability. Run the following command to execute all test cases:

If your changes introduce new functionality, make sure to add new tests to cover them.

npm test

Submitting a Pull Request

Once you're happy with your changes, it's time to submit a Pull Request (PR) to merge your work into the project.

Commit your changes with a descriptive message:

git commit -m "feat(countries): new country validation"

Push to your forked repository:

git push origin your-branch-name

Open a PR on GitHub!

A well-structured PR increases the chances of it being accepted quickly!

Other Ways to Contribute

Not comfortable with coding? You can still contribute in other valuable ways!

Every contribution, big or small, makes a difference! Join us in making Validation Box even better.

Report Bugs – Found an issue? Open a GitHub Issue.
Suggest Features – Have an idea? Start a Feature Discussion.
Improve Documentation – Help make the docs clearer and easier to understand.
Spread the Word – Share Validation Box on Twitter, LinkedIn, and dev communities.

Contributing

On this page