Thank you for considering contributing to Luttaka! We appreciate your interest and support. This document outlines the guidelines and instructions for contributing to our project. Please read them carefully to ensure a smooth and collaborative contribution process.
We welcome contributions of all types, including bug fixes, feature enhancements, documentation improvements, and more. Here are a few ways you can contribute:
You can create issues on the GitHub page, suggesting either:
If you encounter a bug, then please report it as an issue - describing exactly what the bug is, and how to reproduce it.
You are welcome to additionally suggest a solution, either by solving the issue yourself with a pull request (see next section) - or describe a possible solution to the bug, to speed up the resolve for whomever will implement a solve.
There is a bug report issue template that you can use to guide your writing.
If you feel that you have come up with a cool or useful feature that should be added, then please provide one as an issue.
Use the feature request issue template to guide your writing.
You can contribute any and all code you see fit, that helps improve the overall product. In order to get the code into the main source, it will have to be reviewed and approved by the owners of the pull request. However, you are welcome to help in reviewing PRs if you wish, to reduce the review time for other developers.
A pull request can range from bug fixes, new features, any and all code improvements, and documentation improvements.
To get started with contributing, please follow these steps:
- clone the project to your machine (or optionally fork the project first).
- Create a new branch for your contributions.
- for better clarity, please prefix your branch name as follows:
- fix/ (for bug fixes)
- feature/ (for new features and improvements)
- doc/ (for documentation changes)
- for better clarity, please prefix your branch name as follows:
- Make the necessary changes and test them locally.
- Commit your changes with conventional commit messages.
- Push your branch to the repo (or optionally your forked repository).
- Submit a pull request to the main repository.
- Wait for review
When submitting your contributions, please follow these guidelines:
- Clearly describe the purpose and scope of your changes.
- Include any relevant information or motivation behind your changes.
- If your contribution addresses an existing issue, reference the issue number.
- Make sure your code is well-documented, tested, and follows our code style guidelines.
- Provide a clear commit message for each change.
To maintain a consistent code style in our project, please follow the established coding conventions and style guidelines. These guidelines include formatting, naming conventions, and other best practices. We recommend using linters or code formatters to ensure your code aligns with the project's style.
We strongly encourage adding tests for any new features or changes you make. This helps ensure the stability and reliability of our codebase. Please make sure all tests pass before submitting your contributions.
Improving documentation is highly valued. If you find any mistakes, missing information, or areas that need clarification, please help us make the necessary updates. You can also suggest new documentation topics or provide examples and tutorials that can benefit our users.
We expect all contributors and community members to adhere to our community guidelines. These guidelines promote a respectful and inclusive environment for everyone. Please review our Code of Conduct for more details.
If you have any questions, concerns, or suggestions, please reach out to us through one of the following channels:
Please see the license for more details