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 current or future improvements
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use GitHub to host code, track issues, and manage pull requests.
Pull requests are the best way to propose changes to the codebase. We actively welcome them!
- Fork the repo and create your branch from
main. - Install dependencies:
go mod tidy bun install templ generate && bun run build:css - Run the project locally to ensure it builds and runs cleanly:
go run main.go serve
- If you've changed APIs or commands, update documentation where appropriate.
- Ensure tests (if any) pass and run
go fmt ./...to format your code. - Open a pull request!
We’ll review it quickly and provide feedback if needed.
Any contributions you make will be under the MIT License.
When you submit code changes, you agree that your contributions will be licensed under the same MIT License that covers this project.
If you have questions about licensing, open an issue or contact the maintainers.
We use GitHub Issues to track public bugs. To report a bug, open a new issue.
Clear, detailed bug reports help everyone. Here's what helps most:
- A quick summary and background
- Steps to reproduce (be specific; include commands or code snippets)
- What you expected to happen
- What actually happened
- Notes — possible reasons, environment info, or what you've already tried
- Use 2 spaces for indentation
- Follow Go's standard formatting (
go fmt ./...) - Keep HTML and Templ components consistently indented
- Keep Tailwind utility classes readable — for long lists, prefer one per line
By contributing, you agree that your contributions will be licensed under the MIT License.