Contributing Guide

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 maintainer

We Develop with Github

We use GitHub to host code, track issues and feature requests, and accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

1. Fork the repo and create your branch from main.
2. If you've added code that should be tested, add tests using Pest.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints, we use Pint.
6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions will be understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue, it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

• A quick summary and/or background
• Steps to reproduce
  • Be specific!
  • Give sample code if you can.
• What you expected would happen
• What actually happens
• Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

• 4 spaces for indentation rather than tabs
• You can try running vendor/bin/pint for style unification

Commit Message Structure

• chore: Minor tasks, such as updating dependencies or build tools, no production code changes.
• docs: Changes to documentation.
• feat: A new feature for the user (e.g. adding a new button or page).
• fix: A bug fix for the user (e.g., correcting a broken dropdown).
• reform: A change in existing feature to improve it (e.g. changing UI).
• refactor: Restructuring code for clarity or efficiency without altering behavior (e.g. renaming variables for readability, extracting logic into a method).
• style: Code formatting or style changes without altering behavior (e.g. renaming variable in terms of casing, snake_case to camelCase).
• test: Adding or improving tests (unit, integration, etc.), no production code changes.

License

By contributing, you agree that your contributions will be licensed under its MIT License.