Bug Reports and Contributing

Hypanel is an open-source project, and contributions from the community are welcome! Whether you're reporting a bug or contributing code, your help makes Hypanel better for everyone.

Reporting Bugs

Found a bug? Reporting it helps us fix issues and improve Hypanel. Here's how to submit a good bug report:

Before Reporting

Before creating a bug report, please:

1. Check existing issues — Search the GitHub Issues to see if the bug has already been reported
2. Verify it's a bug — Make sure the behavior is actually a bug and not intended functionality
3. Try to reproduce — Confirm you can consistently reproduce the issue
4. Check documentation — Ensure the issue isn't covered in the documentation

Creating a Bug Report

When creating a bug report on GitHub Issues, please include:

Required Information

• Clear title — A concise description of the bug
• Description — What happened and what you expected to happen
• Steps to reproduce — Detailed steps to reproduce the issue:
  1. Go to...
  2. Click on...
  3. See error...
• Expected behavior — What should have happened
• Actual behavior — What actually happened
• Screenshots — If applicable, include screenshots or screen recordings
• Error messages — Copy any error messages from the console or logs

Additional Information

• Hypanel version — The version of Hypanel you're using (e.g., v0.3.5)
• Operating system — Your OS and version (e.g., Ubuntu 22.04, Debian 12)
• Browser — If it's a web interface issue, include browser and version
• Server logs — Relevant log entries from the systemd logs or console
• Console output — Any relevant console errors or messages
• Reproduction frequency — Does it happen every time, sometimes, or randomly?

Bug Report Template

Use this template when creating a bug report:

**Description**
A clear description of what the bug is.

**Steps to Reproduce**
1. Go to '...'
2. Click on '...'
3. See error

**Expected Behavior**
What you expected to happen.

**Actual Behavior**
What actually happened.

**Screenshots**
If applicable, add screenshots.

**Environment**
- Hypanel Version: [e.g., v0.3.5]
- OS: [e.g., Ubuntu 22.04]
- Browser: [if applicable]

**Logs**
Relevant log entries or error messages.

After Reporting

• Be patient — As a hobby project, fixes may take time
• Provide additional info — If asked for more details, please provide them
• Test fixes — If a fix is provided, test it and confirm it works
• Follow up — Update the issue if you discover more information

Contributing Code

Code contributions are welcome! Whether it's fixing bugs, adding features, or improving documentation, your contributions help make Hypanel better.

Getting Started

1. Fork the repository — Create your own fork of hypanel on GitHub
2. Clone your fork — Clone the repository to your local machine
3. Create a branch — Create a new branch for your changes
4. Make your changes — Implement your fix or feature
5. Test your changes — Ensure your changes work correctly
6. Submit a pull request — Open a pull request with your changes

Contribution Guidelines

Code Quality

• Follow existing style — Match the code style and conventions used in the project
• Write clear code — Make your code readable and well-commented
• Test thoroughly — Test your changes to ensure they work as expected
• Handle errors — Include proper error handling

Pull Requests

When submitting a pull request:

• Clear description — Explain what your PR does and why
• Reference issues — Link to any related issues (e.g., "Fixes #123")
• Keep focused — Each PR should address one thing
• Update documentation — If your changes affect functionality, update the docs
• Test changes — Verify your changes work before submitting

Pull Request Template

**Description**
What does this PR do?

**Changes**
- Change 1
- Change 2

**Related Issues**
Closes #123

**Testing**
How was this tested?

Areas for Contribution

You can contribute in many ways:

• Bug fixes — Fix reported bugs
• New features — Implement features from the roadmap or feature requests
• Documentation — Improve or expand documentation
• Code improvements — Refactor, optimize, or improve existing code
• UI/UX improvements — Enhance the user interface or user experience
• Testing — Add tests or improve test coverage

Development Setup

To contribute code, you'll need:

• Git — For version control
• Node.js — Required for both frontend and backend development
• npm or yarn — Package manager for dependencies
• Development environment — Set up according to the project's requirements

Tech Stack:

• Backend: Node.js with Express.js and WebSockets
• Frontend: React web panel using Vite

Check the repository's README and contributing guidelines for specific setup instructions.

Feature Requests

Have an idea for a new feature? Submit it on the GitHub Discussions Feature Requests page.

Feature requests help guide the direction of Hypanel. While not all requests can be implemented, they're all considered and help prioritize development.

Questions and Support

For questions, support, or general discussion:

• GitHub Discussions — Use the General category for questions
• Q&A — Check the Q&A category for answers
• Issues — Use GitHub Issues for bug reports and feature requests

Code of Conduct

When contributing, please:

• Be respectful — Treat everyone with respect and kindness
• Be constructive — Provide helpful, constructive feedback
• Be patient — Remember this is a hobby project
• Follow guidelines — Adhere to project guidelines and standards

Recognition

Contributors are recognized and appreciated! Your contributions help make Hypanel better for everyone in the community.

Thank you for helping improve Hypanel!