CONTRIBUTING.md

Contributing to @maphel/classnames

Thank you for considering contributing to @maphel/classnames. We appreciate your effort and contributions from all skill levels are welcome.

Table of Contents

1. Prerequisites
2. Setting up the Development Environment
3. Coding Guidelines
4. How to Submit a Pull Request
5. Code Review Process
6. License

---

Prerequisites

• Familiarity with TypeScript, and Node.js package management.
• Install Node.js and npm on your system.

---

Setting up the Development Environment

1. Fork the Repository

   Fork the @maphel/classes repository on GitHub and clone your fork locally.

   git clone https://github.com/maphel/classes.git

2. Install Dependencies

   Navigate to the repository folder and install all necessary packages:

   cd classes
   yarn install

3. Branching

   Create a new branch for your feature or bugfix:

   git checkout -b [BRANCH_NAME]

---

Coding Guidelines

• Write your code in TypeScript.

• Make sure your code lints and all tests pass. Run:

  yarn lint
  yarn test
  yarn prettier

• Keep your code as clean and straightforward as possible.

---

How to Submit a Pull Request

1. Commit and Push

   Commit your changes and push them to your fork on GitHub.

   git add .
   git commit -m "Your commit message"
   git push origin [BRANCH_NAME]

2. Start a Pull Request

   Navigate to your fork on GitHub and click the "New Pull Request" button.

3. Describe Your Changes

   Provide a summary and describe the changes you have implemented or the bug you have fixed.

4. Submit for Review

   After creating a pull request, maintainers will review your code. If any changes or fixes are required, they will inform you.

---

Code Review Process

• The core team will review your pull request and provide feedback.
• Once your PR is approved, it will be merged into the master branch.

---

License

By contributing to @maphel/classes, you agree that your contributions will be licensed under its MIT License.