feat: Improve documentation and add project files (#1) (#104)

* feat: Add CONTRIBUTING.md

* feat: Add CODE_OF_CONDUCT.md

* feat: Add SECURITY.md

* feat: Add LICENSE file

* feat: Update README.md with improved documentation and project details

* fix: Generalize README.md for forking workflow

* fix: Correct Project Structure in README.md

* fix: Correct Build Status badge URL in README.md

* fix: Correct Build Status badge URL to point to original repository's live workflow

* fix: Correct License badge URL to point to original repository

Co-authored-by: Jane Alesi <ja@satware.ai>
This commit is contained in:
mw
2025-06-02 17:23:36 +02:00
committed by GitHub
co-authored by ja
parent ee8eba8549
commit faf199aca7
5 changed files with 226 additions and 52 deletions
+25
View File
@@ -0,0 +1,25 @@
# Security Policy
## Reporting a Vulnerability
We take the security of the `satware.ai` website seriously. If you discover any security vulnerabilities, we appreciate your responsible disclosure.
Please report any vulnerabilities by sending an email to [security@satware.ai](mailto:security@satware.ai).
**Please include the following information in your report:**
* A clear and concise description of the vulnerability.
* Steps to reproduce the vulnerability.
* The potential impact of the vulnerability.
* Any proof-of-concept code or screenshots that can help us understand the issue.
## Our Commitment
* We will acknowledge receipt of your report within 2 business days.
* We will investigate the reported vulnerability promptly.
* We will keep you informed about the progress of our investigation and any remediation efforts.
* We will notify you once the vulnerability has been resolved.
We kindly request that you do not disclose the vulnerability publicly until we have had a reasonable opportunity to address it.
Thank you for helping us keep `satware.ai` secure.