Skip to content

Security: Programmers-Paradise/Annie-Docs

SECURITY.md

Security Policy

Supported Versions

We actively support the following versions of Annie documentation:

Version Supported
Latest βœ…
Main βœ…

Reporting a Vulnerability

We take security seriously. If you discover a security vulnerability in the Annie documentation repository, please follow these steps:

πŸ”’ Private Disclosure

DO NOT open a public issue for security vulnerabilities.

Instead, please:

  1. Email us directly at: [email protected]
  2. Use GitHub Security Advisories: Go to the Security tab and click "Report a vulnerability"

πŸ“ What to Include

When reporting a vulnerability, please include:

  • Description of the vulnerability
  • Steps to reproduce the issue
  • Potential impact of the vulnerability
  • Suggested fix (if you have one)
  • Your contact information for follow-up

⏱️ Response Timeline

  • Initial response: Within 48 hours
  • Status update: Within 7 days
  • Resolution timeline: Depends on severity, typically 14-30 days

πŸ” Security Measures

Our documentation repository implements:

  • Automated security scanning with CodeQL
  • Dependency vulnerability checking with safety and bandit
  • Regular security updates via automated workflows
  • Access controls on repository settings and secrets

πŸ† Recognition

We appreciate security researchers who help keep our documentation safe. With your permission, we'll acknowledge your contribution in:

  • Repository security advisories
  • Project documentation
  • Security hall of fame (if applicable)

πŸ“‹ Security Best Practices for Contributors

When contributing to this repository:

  • Keep dependencies updated - Use the automated dependency update PRs
  • Follow secure coding practices - Scripts are scanned with bandit and semgrep
  • Don't commit secrets - Use environment variables and GitHub secrets
  • Review security warnings - Address any CodeQL findings

πŸ”— Related Security Resources


Thank you for helping keep the Annie documentation secure! πŸ›‘οΈ

There aren’t any published security advisories