# Contributing to mini loader

First off, thank you for considering contributing to mini loader! It's people like you that make mini loader such a great tool.

## Code of Conduct

This project and everyone participating in it is governed by the [mini loader Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to s56gkgkq@void.black.

## How Can I Contribute?

### Reporting Bugs

This section guides you through submitting a bug report for mini loader. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

**Before Submitting A Bug Report**

- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/morten-olsen/mini-loader/issues).
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for mini loader, including completely new features and minor improvements to existing functionality.

**Before Submitting An Enhancement Suggestion**

- Check if the enhancement has already been suggested under [Issues](https://github.com/morten-olsen/mini-loader/issues).
- If it hasn't, create a new issue and provide a concise description of the enhancement with as much detail as possible.

### Your First Code Contribution

Unsure where to begin contributing to mini loader? You can start by looking through `beginner` and `help-wanted` issues:

- Beginner issues - issues which should only require a few lines of code, and a test or two.
- Help wanted issues - issues which should be a bit more involved than `beginner` issues.

### Pull Requests

- Fill in the required template
- Do not include issue numbers in the PR title
- Follow the coding style used throughout the project
- Include appropriate test coverage. New features should include new tests.
- Document new code based on the [Documentation Styleguide](#documentation-styleguide)

## Documentation Styleguide

Use this style guide for documentation:

- Use Markdown
- Reference methods and classes in markdown backticks. For example, `ClassName.methodName`
- Document new code or add comments in code to explain parts that might be confusing.

## Use a Consistent Coding Style

* 2 spaces for indentation rather than tabs
* You can try running `pnpm run test:lint` for style unification

## License

By contributing to mini loader, you agree that your contributions will be licensed under its GPL-3 License.
