Contributing

Contributing

We welcome contributions to our project! This document will guide you through the process of contributing.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How to Contribute

Reporting Bugs

  1. Ensure the bug was not already reported by searching on GitHub under Issues (opens in a new tab).
  2. If you're unable to find an open issue addressing the problem, open a new one (opens in a new tab). Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  1. Open a new issue with a clear title and detailed description of the suggested enhancement.
  2. Include any relevant code samples or screenshots if applicable.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Development Setup

  1. Fork and clone the repo.
  2. Run npm install to install dependencies.
  3. Create a branch for your changes.
  4. Make your changes and commit them with a clear commit message.
  5. Push your changes to your fork.
  6. Submit a pull request.

Style Guide

  • Use 2 spaces for indentation.
  • Use camelCase for variable and function names.
  • Use PascalCase for component names.
  • Write clear, concise comments.

License

By contributing, you agree that your contributions will be licensed under the project's MIT License.

Thank you for contributing to our project!