mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2026-04-09 03:31:51 -07:00
548d237c38
Some checks failed
✅ Code checks / check-url-paths (push) Has been cancelled
✅ Code checks / lint (push) Has been cancelled
✅ Code checks / docker-tests (push) Has been cancelled
🐳 👩💻 docker dev / docker_dev (push) Has been cancelled
📘 Deploy MkDocs / deploy (push) Has been cancelled
Signed-off-by: jokob-sk <jokob.sk@gmail.com>
98 lines
3.7 KiB
Markdown
Executable File
98 lines
3.7 KiB
Markdown
Executable File
# Contributing to NetAlertX
|
|
|
|
First off, **thank you** for taking the time to contribute! NetAlertX is built and improved with the help of passionate people like you.
|
|
|
|
---
|
|
|
|
## Issues, Bugs, and Feature Requests
|
|
|
|
Please use the [GitHub Issue Tracker](https://github.com/netalertx/NetAlertX/issues) for:
|
|
- Bug reports
|
|
- Feature requests
|
|
- Documentation feedback
|
|
|
|
Before opening a new issue:
|
|
- [Check Common Issues & Debug Tips](https://docs.netalertx.com/DEBUG_TIPS#common-issues)
|
|
- [Search Closed Issues](https://github.com/netalertx/NetAlertX/issues?q=is%3Aissue+is%3Aclosed)
|
|
|
|
---
|
|
|
|
## Contributing without coding knowledge
|
|
|
|
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](./GROWTH.md))
|
|
- 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
|
|
|
|
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.
|
|
|
|
|
|
---
|
|
|
|
## Submitting Pull Requests (PRs)
|
|
|
|
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](https://docs.netalertx.com/PLUGINS_DEV)
|
|
- 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
|
|
|
|
## Commit Messages
|
|
|
|
- Use clear, descriptive commit messages
|
|
- Explain *why* a change was made, not just *what* changed
|
|
- Reference related issues where applicable
|
|
|
|
## Code Quality
|
|
|
|
- Read and follow the [code standards](/.github/skills/code-standards/SKILL.md)
|
|
|
|
---
|
|
|
|
## First-Time Contributors
|
|
|
|
New to open source? Check out these resources:
|
|
- [How to Fork and Submit a PR](https://opensource.guide/how-to-contribute/)
|
|
- Ask questions or get support in our [Discord](https://discord.gg/NczTUTWyRr)
|
|
|
|
---
|
|
|
|
## Code of Conduct
|
|
|
|
By participating, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md), which ensures a respectful and welcoming community.
|
|
|
|
---
|
|
|
|
## Contact
|
|
|
|
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](mailto:jokob.sk@gmail.com?subject=NetAlertX%20Contribution)
|
|
|
|
We appreciate every contribution, big or small! 💙
|