Welcome to our open-source project! We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a Bug
- Discussing the Current State of the Code
- Submitting a Fix
- Proposing New Features
- Becoming a Moderator
We appreciate your interest in contributing to our repository. Before you get started, please take a moment to review the guidelines below.
- Fork the repository and clone it locally.
- Create a new branch for your changes.
- Make your changes and test them locally.
- Submit a pull request (PR) to the
mainbranch of the original repository. - Your PR will be reviewed by a moderator. If there are any requested changes, make them and push them to your branch, and your PR will be updated automatically.
- Once your changes are approved and merged, you can delete your branch.
- All notes must be in markdown only.
- All pull requests must address an issue.
- Write clear and concise commit messages and pull request descriptions.
- If you're fixing a bug, please include a test case that demonstrates the bug.
If you find a bug or have a feature request, please open an issue in the repository. Please provide a clear and concise description of the issue or request, and include any relevant information, such as error messages or steps to reproduce.
- Use tables over lists whenever possible.
- Use mermaid flowcharts.
- Use LaTeX for mathematical/scientifical expressions.
- If you're not familiar with markdown, please refer to this.
By contributing, you agree that your contributions will be licensed under Open Software License 3.0.
We welcome contributions from everyone, and we appreciate your help in making our project better. Thank you for your support!