Contributing Guide

Thank you for your interest in contributing to this project! We appreciate your help in making it better.

Introduction

This document outlines the guidelines for contributing to this project. It covers submitting issues, creating pull requests, and maintaining code quality.

Submitting Issues

If you encounter any issues or have suggestions for improvements, please follow these guidelines when submitting an issue:

1. Before submitting an issue, search the issue tracker to check if the issue has already been reported.
2. Provide a clear and descriptive title for the issue.
3. Include detailed steps to reproduce the issue.
4. Include any relevant error messages or screenshots.
5. Specify the version of the project you are using.
6. Be respectful and constructive in your communication.

Pull Requests

We welcome contributions in the form of pull requests. To submit a pull request, please follow these guidelines:

1. Fork the repository and create a new branch for your feature or bug fix.
2. Ensure your code follows the project's code style guidelines (see Code Style).
3. Write clear and concise commit messages.
4. Include tests for your changes, if applicable.
5. Document any new features or changes in the project's documentation.
6. Submit the pull request and provide a detailed description of the changes made.

Code Style

To maintain a consistent codebase, we follow a set of code style guidelines. Please ensure that your code adheres to these guidelines before submitting a pull request. Some general guidelines include:

• Use meaningful variable and function names.
• Write clear and concise comments.
• Follow the project's indentation and formatting conventions.
• Keep lines of code within a reasonable length.
• Remove any unnecessary code or comments.
• Make sure to run npm run fmt before committing!

License

This project is licensed under the BSD-3-Clause License. By contributing to this project, you agree to license your contributions under the same license.