Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (45 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 2.56 KB

Contributing to Habo

We’re excited that you’re interested in contributing to Habo! 🎉
Our goal is to make the contribution process clear, productive, and respectful for everyone.

Whether you’re reporting a bug, suggesting an enhancement, or submitting a pull request (PR), please follow these guidelines.

📝 How to Contribute

1. Start with an Issue

  • Before writing any code, please create an issue to:
    • Report a bug
    • Request a new feature
    • Propose an improvement

This gives the community and maintainers a chance to discuss the change before work begins.

2. Fork & Branch

  • Fork the repo and create a new branch from main.
    • Use a descriptive branch name, e.g. fix/login-bug or feature/dark-mode.

3. Keep Pull Requests Focused

  • Each PR should relate only to the issue or feature it addresses.
  • Do not include unrelated changes such as formatting, whitespace cleanup, or refactors.
  • If you want to make formatting or refactoring changes, open a separate PR for that.

4. Development Checklist

Before submitting a PR, please ensure:

  • ✅ The change is tested and works on Android and iOS.
  • ✅ Code passes linting and formatting checks.
  • ✅ Any new functionality has appropriate tests (if applicable).
  • ✅ Commit messages are clear and descriptive.

🔄 Pull Request Process

  1. Link the PR to the related issue using GitHub’s “Linked Issues” feature.
  2. Add a clear description of what the change does and why it’s needed.
  3. Request a review from a maintainer.
  4. Address review comments (if any) and update your branch before merging.

🐞 Reporting Bugs

We use GitHub Issues to track bugs. When filing a bug report, please include:

  • A clear summary of the problem.
  • Steps to reproduce (with code snippets if possible).
  • What you expected to happen vs. what actually happened.
  • Environment details (OS, device, dependencies, etc.).

The more detail, the faster we can help.

📜 License

By contributing, you agree that your contributions will be licensed under the GNU General Public License v3.0.

🙌 Acknowledgments

This guide was adapted and modernized from the briandk contributing template.