Просмотр исходного кода

feat: add CODE_OF_CONDUCT and SECURITY.md files for community guidelines and vulnerability reporting

CaIon 1 месяц назад
Родитель
Сommit
04de79ac43
2 измененных файлов с 169 добавлено и 0 удалено
  1. 83 0
      .github/CODE_OF_CONDUCT.md
  2. 86 0
      .github/SECURITY.md

+ 83 - 0
.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,83 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at:
+
+**Email:** support@quantumnous.com
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact:** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence:** A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact:** A violation through a single incident or series of actions.
+
+**Consequence:** A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact:** A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence:** A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact:** Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence:** A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
+
+[homepage]: https://www.contributor-covenant.org

+ 86 - 0
.github/SECURITY.md

@@ -0,0 +1,86 @@
+# Security Policy
+
+## Supported Versions
+
+We provide security updates for the following versions:
+
+| Version | Supported          |
+| ------- | ------------------ |
+| Latest  | :white_check_mark: |
+| Older   | :x:                |
+
+We strongly recommend that users always use the latest version for the best security and features.
+
+## Reporting a Vulnerability
+
+We take security vulnerability reports very seriously. If you discover a security issue, please follow the steps below for responsible disclosure.
+
+### How to Report
+
+**Do NOT** report security vulnerabilities in public GitHub Issues.
+
+To report a security issue, please use the GitHub Security Advisories tab to "Open a draft security advisory". This is the preferred method as it provides a built-in private communication channel.
+
+Alternatively, you can report via email:
+
+- **Email:** support@quantumnous.com
+- **Subject:** `[SECURITY] Security Vulnerability Report`
+
+### What to Include
+
+To help us understand and resolve the issue more quickly, please include the following information in your report:
+
+1. **Vulnerability Type** - Brief description of the vulnerability (e.g., SQL injection, XSS, authentication bypass, etc.)
+2. **Affected Component** - Affected file paths, endpoints, or functional modules
+3. **Reproduction Steps** - Detailed steps to reproduce
+4. **Impact Assessment** - Potential security impact and severity assessment
+5. **Proof of Concept** - If possible, provide proof of concept code or screenshots (do not test in production environments)
+6. **Suggested Fix** - If you have a fix suggestion, please provide it
+7. **Your Contact Information** - So we can communicate with you
+
+## Response Process
+
+1. **Acknowledgment:** We will acknowledge receipt of your report within **48 hours**.
+2. **Initial Assessment:** We will complete an initial assessment and communicate with you within **7 days**.
+3. **Fix Development:** Based on the severity of the vulnerability, we will prioritize developing a fix.
+4. **Security Advisory:** After the fix is released, we will publish a security advisory (if applicable).
+5. **Credit:** If you wish, we will credit your contribution in the security advisory.
+
+## Security Best Practices
+
+When deploying and using New API, we recommend following these security best practices:
+
+### Deployment Security
+
+- **Use HTTPS:** Always serve over HTTPS to ensure transport layer security
+- **Firewall Configuration:** Only open necessary ports and restrict access to management interfaces
+- **Regular Updates:** Update to the latest version promptly to receive security patches
+- **Environment Isolation:** Use separate database and Redis instances in production
+
+### API Key Security
+
+- **Key Protection:** Do not expose API keys in client-side code or public repositories
+- **Least Privilege:** Create different API keys for different purposes, following the principle of least privilege
+- **Regular Rotation:** Rotate API keys regularly
+- **Monitor Usage:** Monitor API key usage and detect anomalies promptly
+
+### Database Security
+
+- **Strong Passwords:** Use strong passwords to protect database access
+- **Network Isolation:** Database should not be directly exposed to the public internet
+- **Regular Backups:** Regularly backup the database and verify backup integrity
+- **Access Control:** Limit database user permissions, following the principle of least privilege
+
+## Security-Related Configuration
+
+Please ensure the following security-related environment variables and settings are properly configured:
+
+- `SESSION_SECRET` - Use a strong random string
+- `SQL_DSN` - Ensure database connection uses secure configuration
+- `REDIS_CONN_STRING` - If using Redis, ensure secure connection
+
+For detailed configuration instructions, please refer to the project documentation.
+
+## Disclaimer
+
+This project is provided "as is" without any express or implied warranty. Users should assess the security risks of using this software in their environment.