First off, thank you for considering contributing to our project. Your help is greatly appreciated!
If you find a bug, please open an issue here and include as much detail as possible. Before creating a new issue, please check to see if the bug has already been reported.
A good bug report should include:
- A clear and descriptive title.
- A detailed description of the problem, including steps to reproduce.
- Any relevant logs, screenshots, or code snippets.
We welcome enhancements and improvements! To suggest an enhancement, please open an issue here with the following details:
A good enhancement suggestion should include:
- A clear and descriptive title.
- A detailed explanation of the enhancement and why it would be useful.
- Any relevant code snippets or examples.
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repository.
- Create a branch for your feature or bug fix (
git checkout -b "#1-add-functionality"). - Commit your changes (
git commit -m "Add new feature"). - Push to the branch (
git push origin "#1-add-functionality"). - Open a pull request here.
Your pull request should:
- Contain the issue number in the title (e.g.,
#1 - Add new functionality). - Include a clear description of what your changes do.
- Reference any related issues.
- Follow the project's coding standards.
- Use the present tense ("Add feature" not "Added feature").
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
- Limit the first line to 72 characters or less.
- Reference issues and pull requests liberally.
- Keep code styled as in the repository.
- You can use
composer csffor fixing code style.
Please don't create issues with questions about using package, refer to documentation or FAQ first. You can also contact us at
jakub.kermes@studenci.collegiumwitelona.pl
piotr.fedak@studenci.collegiumwitelona.pl
or message Blumilk directly.
Thank you for contributing to BLT!