mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2025-12-06 17:15:38 -08:00
54 lines
1.8 KiB
Markdown
Executable File
54 lines
1.8 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/jokob-sk/NetAlertX/issues) for:
|
|
- Bug reports 🐞
|
|
- Feature requests 💡
|
|
- Documentation feedback 📖
|
|
|
|
Before opening a new issue:
|
|
- 🛑 [Check Common Issues & Debug Tips](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md#common-issues)
|
|
- 🔍 [Search Closed Issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed)
|
|
|
|
---
|
|
|
|
## 🚀 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://github.com/jokob-sk/NetAlertX/blob/main/docs/PLUGINS_DEV.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@duck.com](mailto:jokob@duck.com?subject=NetAlertX%20Contribution)
|
|
|
|
We appreciate every contribution, big or small! 💙
|