Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 2.82 KB
Raw

Contributing Guide

Thanks for your interest in contributing to the project! This document provides a high-level overview of how you can get involved.

There are many ways to contribute, from submitting bug reports and feature requests to writing code which can be incorporated into the project itself. To help you get started, we've put together the following guidelines.

Code Contributions

These are the steps to follow if you want to contribute code to the project (either by fixing a bug or adding a new feature).

  1. Fork the repository to your own GitHub account and then clone it to your local device.
  2. Create a new branch for your changes: git checkout -b my-branch-name.
  3. Make and test your changes.
  4. Commit your changes: git commit -m "My message".
  5. Push your changes to your fork: git push origin my-branch-name.
  6. Submit a pull request to the main branch of the main repository.
  7. Pat yourself on the back and wait for your pull request to be reviewed and merged.
  8. Celebrate your contribution to the project! 🎉

Bug Reports

If you find a bug in the project, please submit an issue to the GitHub repository using the provided template for bug reports. This ensures that your report contains all of the information we need to investigate and fix the bug.

Feature Requests

If you have an idea for a new feature, please submit an issue to the GitHub repository using the provided template for feature requests. This ensures that your request contains all of the information we need to evaluate it.

Security Vulnerabilities

If you discover a security vulnerability within the project, please send a message to one of the collaborators or open a draft security advisory using the provided template for security vulnerabilities. All security vulnerabilities will be promptly addressed.

Questions

If you have any questions about the project, you can submit an issue to the GitHub repository or send a message to one of the collaborators. Make sure to select the question label for your issue so that it can be easily identified.

License

The project is open-sourced software licensed under the MIT license, thus all contributions will be released under this license. Please read it before contributing to the project.