Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.63 KB

contributing.adoc

File metadata and controls

54 lines (36 loc) · 1.63 KB

Contributing

Thank you for considering contributing to this project! To ensure that submissions run smoothly, please review the following guidelines.

What We Want

We welcome any contributions that help improve this project. Here are some examples of the kinds of contributions we are looking for:

  • Bug reports and feature requests

  • Code improvements and bug fixes

  • Design and performance improvements

  • Documentation improvements

  • Submodule Updates

If you are uncertain about whether your contribution aligns with the scope of this project, please review what we do not want. Feel free to reach out to the maintainers, if you have any questions.

What We Do Not Want

While we appreciate all contributions that help improve this project, some may not align with our vision, require further discussion, or may be better suited for a fork. Here are some examples that may fall into this category:

  • Small throw-away homework assignments

If you are uncertain about whether your contribution aligns with the scope of this project, please review what we want. Feel free to reach out to the maintainers, if you have any questions.

Contribution Guidelines

Contribution Process

To contribute changes, adhere to the GitHub Flow.

Commit Messages

Follow Commitizen's commit standards.

Code of Conduct

To maintain a respectful community, please review our code of conduct.

License

This project is licensed under MIT.