Skip to main content
Thank you for your interest in contributing to Hiro CRM! This guide will help you get started with contributing to the project.

​
Ways to Contribute

​
Reporting Bugs

If you find a bug in Hiro CRM, please help us fix it:
1

Search existing issues

Check the GitHub Issues to see if the bug has already been reported.
2

Open a new issue

If the bug hasn’t been reported, create a new issue with a clear title and description.
3

Provide details

Include:
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Screenshots or error messages (if applicable)
  • Your environment (browser, OS, Node version)

​
Suggesting Features

We welcome feature suggestions that improve Hiro CRM for hospitality businesses:
1

Open an enhancement issue

Create a new issue with the enhancement label.
2

Describe the feature

Explain:
  • What problem does this feature solve?
  • How would it work from a user’s perspective?
  • Why is this valuable for hospitality businesses?
3

Include mockups

If possible, add mockups, wireframes, or examples from other tools.

​
Submitting Pull Requests

Ready to contribute code? Here’s the workflow:
1

Fork the repository

Fork hiro-crm to your GitHub account.
2

Create a feature branch

git checkout -b feature/your-feature-name
Use descriptive branch names:
  • feature/loyalty-tier-upgrade
  • fix/reservation-sync-error
  • docs/update-api-guide
3

Make your changes

Follow the code standards and write tests for new functionality.
4

Verify the build

cd frontend
npm run type-check
npm run test:run
5

Commit with a clear message

git commit -m "feat: add loyalty tier upgrade notifications"
See commit message format for guidelines.
6

Push and open a PR

git push origin feature/your-feature-name
Open a Pull Request on GitHub with:
  • A clear title and description
  • Screenshots or videos for UI changes
  • Reference to any related issues

​
Code of Conduct

We are committed to providing a welcoming and inclusive environment:
  • Be respectful and considerate
  • Focus on constructive feedback
  • Welcome newcomers and help them get started
  • Assume good intentions

​
Questions?

If you have questions about contributing:
  • Open a GitHub Discussion
  • Ask in the Issues section
  • Check existing documentation and issues first

​
License

By contributing to Hiro CRM, you agree that your contributions will be licensed under the MIT License.

​
Next Steps

Development Setup

Set up your local development environment

Code Standards

Learn our coding conventions and commit format

Testing

Write and run tests for your contributions

Build docs developers (and LLMs) love

Get started for freeTalk to us