Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

39 lines (26 loc) · 2.39 KB
Raw

Contributing Guidelines

Thank you for your interest in contributing to this project! We appreciate your support and collaboration. Please take a moment to review the following guidelines to ensure a smooth contribution process.

Issue Reporting

If you encounter any issues or bugs while using the project, please open an issue on our issue tracker. Provide as much detail as possible about the problem, including steps to reproduce it, expected behavior, and any error messages or screenshots.

Feature Requests

If you have an idea for a new feature or enhancement, we welcome your suggestions! Please open an issue and describe the proposed feature in detail. We'll review it and provide feedback.

Pull Requests

We encourage and appreciate pull requests from the community. If you'd like to contribute code to the project, please follow these steps:

  1. Fork the repository to your own GitHub account.
  2. Switch to the dev branch of the repository.
  3. Make your changes, ensuring that your code follows the project's coding conventions.
  4. Test your changes to make sure they work as intended.
  5. Commit your changes with clear and descriptive commit messages.
    • If the pull request is related to an issue, please mention the issue number in the comments (e.g., #16).
    • Please prefer clarity over brevity in all cases (variable names, conditions, functions...).
    • Do not edit files in the dist/ directory.
  6. Push your branch to your forked repository on GitHub.
  7. Open a pull request from your branch to the dev branch of the main repository.
  8. Provide a detailed description of your changes in the pull request, including any relevant context or background information.
    • Describe the problem in the Pull Request description (of course, you would do it, why do I mention that?)
  9. Thank you for your commitment!

Code Style and Conventions

Please make sure that your code adheres to the project's coding style and conventions. This ensures consistency and readability throughout the codebase. If there are specific guidelines or conventions to follow, they will be documented in the project's code style guide or README.

Licensing

By contributing to this project, you agree to license your contributions under the same license as the project.

Thank you for your contributions! Together, we can make this project even better.