From 2de0b0ca1d7979c0905765feecc27b34f287fa8d Mon Sep 17 00:00:00 2001 From: Luca Guelfi Date: Wed, 20 May 2026 20:08:25 +0200 Subject: [PATCH] docs: add CONTRIBUTING.md and SECURITY.md for community engagement --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ SECURITY.md | 16 ++++++++++++++++ 2 files changed, 45 insertions(+) create mode 100644 CONTRIBUTING.md create mode 100644 SECURITY.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b3a0bc6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# Contributing + +Thanks for your interest in contributing! 🎉 + +## How to Contribute + +1. **Fork** the repository +2. **Create a feature branch**: `git checkout -b feature/my-feature` +3. **Commit your changes**: `git commit -m 'Add my feature'` +4. **Push to the branch**: `git push origin feature/my-feature` +5. **Open a Pull Request** + +## Guidelines + +- Keep PRs small and focused +- Add tests for new functionality +- Follow existing code style +- Update documentation if needed + +## Reporting Issues + +- Use GitHub Issues to report bugs +- Include steps to reproduce +- Mention your OS and Python version + +## Questions? + +Open an issue or reach out at [evey.cc](https://evey.cc). + diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..9621da0 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,16 @@ +# Security Policy + +## Reporting a Vulnerability + +If you discover a security vulnerability, please report it responsibly: + +- **Do NOT** open a public issue +- Email: security@evey.cc or report via GitHub Security Advisories +- Include details about the vulnerability and steps to reproduce + +We will respond within 48 hours and keep you updated on the fix. + +## Supported Versions + +Only the latest release is actively supported for security updates. +