Skip to content

Latest commit

 

History

History
99 lines (64 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

99 lines (64 loc) · 2.67 KB
Raw

Contributing to MaxValid

Thank you for considering contributing to MaxValid! We appreciate your interest in improving the package. Here's a guide to help you get started with contributing.

Table of Contents

Getting Started

Prerequisites

To contribute to MaxValid, you need to have the following software installed on your system:

  • Node.js (version >= 12)
  • npm (version >= 6)

Installation

  1. Fork the MaxValid repository on GitHub.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/techmonowar/maxvalid.git

  3. Navigate to the cloned directory:

    cd maxvalid

  4. Install the dependencies:

    npm install

Making Changes

Branching

Create a new branch for your changes. Use a descriptive branch name that reflects the purpose of your changes:

git checkout -b your-branch-name

Development

Make the necessary changes to the codebase to address the issue or implement the new feature you're working on. Ensure that you follow the code style guidelines mentioned in the Code Style section.

Test your changes locally to ensure they work as expected:

npm test

Submitting Changes

Once you have made your changes and tested them locally, you can submit your contribution by following these steps:

  1. Commit your changes with a descriptive commit message:

    git commit -m "Your commit message"

  2. Push your changes to your forked repository:

    git push origin your-branch-name

  3. Open a pull request (PR) on the official MaxValid repository on GitHub. Provide a clear title and description for your PR, outlining the changes you made.

    Our team will review your contribution, provide feedback if necessary, and merge it into the main codebase once it meets the project's standards.

Code Style

To maintain consistency and readability, we follow a set of code style guidelines. Please ensure that your code adheres to the following:

  • Use meaningful variable and function names.
  • Indent code using 2 spaces.
  • Use camelCase for variable and function names.
  • Write clear and concise comments.
  • Follow the existing coding patterns in the project.

License

By contributing to MaxValid, you agree that your contributions will be licensed under the MIT License.