2.6 KiB
Contributing to HAMi-WebUI
Thank you for your interest in contributing to HAMi-WebUI! We welcome all people who want to contribute in a healthy and constructive manner within our community.
This document is a guide to help you through the process of contributing to HAMi-WebUI.
Become a contributor
You can contribute to HAMi-WebUI in several ways. Here are some examples:
- Contribute to the HAMi-WebUI codebase.
- Report and triage bugs.
- Write technical documentation and blog posts, for users and contributors.
- Help others by answering questions about HAMi-WebUI.
For more ways to contribute, check out the Open Source Guides.
Report bugs
Before submitting a new issue, try to make sure someone hasn't already reported the problem. Look through the existing issues for similar issues.
Report a bug by submitting a bug report. Make sure that you provide as much information as possible on how to reproduce the bug.
For authentication and alerting HAMi-WebUI server logs are useful.
Suggest enhancements
If you have an idea of how to improve HAMi-WebUI, submit a feature request.
We want to make HAMi-WebUI accessible to even more people. Submit an accessibility issue to help us understand what we can improve.
Write documentation
We welcome your expertise and input as our body of technical content grows.
Your first contribution
Unsure where to begin contributing to HAMi-WebUI? Start by browsing issues labeled beginner friendly or help wanted.
- Beginner-friendly issues are generally straightforward to complete.
- Help wanted issues are problems we would like the community to help us with regardless of complexity.
If you're looking to make a code change, see how to set up your environment for local development.
When you're ready to contribute, it's time to create a pull request.
Where do I go from here?
- Set up your development environment.