Files
NetAlertX/CONTRIBUTING.md
Jokob @NetAlertX ec3e4c8988 feat(api): Enhance session events API with pagination, sorting, and filtering
- Added support for pagination (page and limit) in the session events endpoint.
- Implemented sorting functionality based on specified columns and directions.
- Introduced free-text search capability for session events.
- Updated SQL queries to retrieve all events and added a new SQL constant for events.
- Refactored GraphQL types and helpers to support new plugin and event queries.
- Created new GraphQL resolvers for plugins and events with pagination and filtering.
- Added comprehensive tests for new GraphQL endpoints and session events functionality.
2026-03-26 20:57:10 +00:00

2.9 KiB
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 for:

  • Bug reports
  • Feature requests
  • Documentation feedback

Before opening a new issue:


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
  • 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


First-Time Contributors

New to open source? Check out these resources:


Code of Conduct

By participating, you agree to follow our Code of Conduct, 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

We appreciate every contribution, big or small! 💙