First off, thank you for taking the time to contribute! NetAlertX is built and improved with the help of passionate people like you.
Please use the GitHub Issue Tracker for:
- Bug reports
- Feature requests
- Documentation feedback
Before opening a new issue:
Writing code is not the only way how you can contribute to the project. Here are some ideas how you can help out otherwise:
- Help improving the documentation (text, typos, use cases, screenshots - all this makes things better)
- Share your favorite project on socials (see Growth ideas)
- Write a blog post, or a how-to set-up guide
- Write how it helped you to achieve something fun or interesting to simplify your personal or work life
- Help with the translation effort
- Running a nightly or dev build to test for bugs before they make it to the production release
- Report bugs and features with sufficient detail and care (super important to ease everyone's maintenance burden and minimize back-and-forth)
- running a projects test suite
Use of AI-assisted tools is permitted, provided all generated code is reviewed, understood, and verified before submission.
- All AI-generated code must meet the project's quality, security, and performance standards.
- Contributors are responsible for fully understanding any code they submit, regardless of how it was produced.
- Prefer clarity and maintainability over cleverness or brevity. Readable code is always favored over dense or obfuscated implementations.
- Follow the DRY (Don't Repeat Yourself) principle where appropriate, without sacrificing readability.
- Do not submit code that you cannot confidently explain or debug.
All changes must pass the full test suite before opening a PR.
We welcome PRs to improve the code, docs, or UI!
Please:
- Ensure backward compatibility with existing installations
- Preserve existing features unless a breaking change is intentional and discussed
- Follow existing code style and structure
- Provide a clear title and description for your PR
- If relevant, add or update tests and documentation
- For plugins, refer to the Plugin Dev Guide
- Switch the PR to DRAFT mode if still being worked on
- Keep PRs focused and minimal — avoid unrelated changes in a single PR
- PRs that do not meet these guidelines may be closed without review
- Use clear, descriptive commit messages
- Explain why a change was made, not just what changed
- Reference related issues where applicable
- Read and follow the code standards
New to open source? Check out these resources:
- How to Fork and Submit a PR
- Ask questions or get support in our Discord
By participating, you agree to follow our Code of Conduct, which ensures a respectful and welcoming community.
If you have more in-depth questions or want to discuss contributing in other ways, feel free to reach out at: jokob.sk@gmail.com
We appreciate every contribution, big or small! 💙