Skip to content

Contributing Guidelines and Copyright Notice

Contributing Guidelines

We welcome contributions from everyone. Please read these guidelines before submitting a pull request or issue.

Code of Conduct

We expect all contributors to adhere to our Code of Conduct. Please read it before contributing.

Issues

If you find a bug or have a feature request, please submit an issue on our GitHub issue tracker. Please check the existing issues to make sure your issue hasn't already been reported.

When submitting an issue, please provide as much detail as possible, including steps to reproduce the issue if applicable.

Pull Requests

We welcome pull requests from everyone. Please ensure that your PR adheres to the following guidelines:

  1. Before submitting a PR, please create an issue first and wait for approval from a project maintainer.
  2. Your code should follow our style guide.
  3. Write tests for any new functionality.
  4. Ensure that all tests pass before submitting your pull request.
  5. Include documentation for any new functionality you've added.
  6. Make sure your code has no linter errors or warnings.
  7. Be sure to explain what your changes do and why they are necessary.

Getting Started

To get started with contributing, take a look at the issues on our GitHub issue tracker. If you have any questions or need any help, please don't hesitate to reach out to us on Slack.

Thank you for contributing to our project!

Copyright (c) 2025 Paulo Cachim

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.