From 23003aa82fcec67073769e8512efcd1daa40e6ab Mon Sep 17 00:00:00 2001 From: Ashtin <137578700+slammingprogramming@users.noreply.github.com> Date: Wed, 25 Jun 2025 04:51:27 -0400 Subject: [PATCH] Update contributing page Updated the page for better readability, additional information, and to add recent additions in this branch to it --- CONTRIBUTING | 55 ++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 47 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index 423166a5..887864d7 100755 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -1,14 +1,53 @@ -# Contributing to this project +# 🤝 Contributing to NetAlertX -## Issues, bugs, feature requests +First off, **thank you** for taking the time to contribute! NetAlertX is built and improved with the help of passionate people like you. -The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests. +--- -Before submitting a new issue please spend a couple of minutes on research: +## 📂 Issues, Bugs, and Feature Requests -* Check [🛑 Common issues](https://github.com/jokob-sk/NetAlertX/blob/main/docs/DEBUG_TIPS.md#common-issues) -* Check [💡 Closed issues](https://github.com/jokob-sk/NetAlertX/issues?q=is%3Aissue+is%3Aclosed) if a similar issue was solved in the past. +Please use the [GitHub Issue Tracker](https://github.com/jokob-sk/NetAlertX/issues) for: +- Bug reports 🐞 +- Feature requests 💡 +- Documentation feedback 📖 -## Pull-requests (PRs) +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) -If you submit a PR please do check that your changes are backward compatible with existing installations. Existing features should be always preserved. +--- + +## 🚀 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! 💙 \ No newline at end of file