Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 1.75 KB

File metadata and controls

76 lines (52 loc) · 1.75 KB

🤝 Contributing to Hulo

Thank you for your interest in contributing to Hulo!
We welcome all contributions — code, documentation, bug reports, suggestions, and more.


🧰 Getting Started

1. Fork the Repository

Click the Fork button at the top right of this page and clone your fork:

git clone https://github.com/<your-username>/hulo.git
cd hulo
  1. Install Dependencies Make sure you have the required tools installed:
  • Go (version 1.23.5 or higher)

Then run:

go mod tidy

🚀 Contribution Types

Here are some ways you can help:

  • 🐞 Report bugs – open an issue
  • Request features – propose ideas via issues
  • 💻 Contribute code – bug fixes, new features, or enhancements
  • 📖 Improve docs – fix typos, write tutorials, or translate content
  • 🔌 Write plugins/tools – expand the ecosystem

📦 Making a Pull Request

Create a new branch:

git checkout -b fix/my-bug-fix

Commit your changes:

git commit -m "fix: correct output path resolution"

Push your branch:

git push origin fix/my-bug-fix

Open a Pull Request on GitHub.

Please make sure your code:

  • Is well-formatted and readable
  • Passes all tests (if applicable)
  • Includes related documentation updates if needed

🧪 Code Style & Testing

Follow the code style conventions in the repository.

Run tests locally before pushing.

Use descriptive commit messages (feat:, fix:, chore: etc.).

🙏 Code of Conduct

Be respectful and constructive. We follow a Code of Conduct to foster a welcoming community.

💬 Questions?

Feel free to reach out by opening an issue or joining our community discussions.

Thanks again for being part of the Hulo journey 🚀