Skip to content

OpenAI's Codex Security CLI and TypeScript SDK for finding, validating, and fixing security vulnerabilities. npm: https://www.npmjs.com/package/@openai/codex-security

docs: welcome open-source maintainers and contributors (#107)

mldangelo-oai06c840f8eb8d
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 19cdb71f9..303eb270a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,26 +1,45 @@
# Contributing
-Codex Security is developed in OpenAI's canonical repository and published to
-this repository through a one-way mirror. External pull requests cannot be
-imported into the canonical source.
+Thanks for helping improve Codex Security. We welcome bug reports, feature
+requests, documentation corrections, and feedback from open-source
+maintainers.
+
+## How this repository works
+
+Codex Security is developed in OpenAI's canonical repository and published
+here through a one-way mirror. We can't import pull requests from this
+repository into the canonical source.
+
+Search [existing issues](https://github.com/openai/codex-security/issues)
+before opening a new one. Maintainers can carry accepted changes into the
+canonical source or invite a focused pull request for this public repository.
+
+## Support for open-source projects
+
+If you maintain an open-source project,
+[open an issue](https://github.com/openai/codex-security/issues/new) with the
+repository, your role, and what you need. Support is best effort. Scan only
+repositories you trust and either own or have permission to assess.
## Report a bug
-Search [existing GitHub issues](https://github.com/openai/codex-security/issues)
-before opening a new one. Include the installed CLI or SDK version, operating
-system, reproduction steps, expected behavior, and the observed result.
+Include your CLI or SDK version, operating system, reproduction steps, and
+the expected and observed behavior. Remove credentials, private code,
+customer data, and security findings before posting.
+
+## Suggest a feature or improve the documentation
-Remove API keys, access tokens, repository contents, security findings, and
-other sensitive information from public reports. Report security vulnerabilities
-privately as described in [SECURITY.md](SECURITY.md).
+Open an issue describing the problem and the workflow you want to support.
+Documentation corrections and safe examples are welcome.
-## Request a feature or improve the documentation
+## Report a security issue
-Open a GitHub issue describing the problem, the workflow you want to support,
-and any relevant product behavior. Documentation corrections and safe
-reproduction details are welcome in the issue discussion.
+Report Codex Security vulnerabilities privately as described in
+[SECURITY.md](SECURITY.md). Do not post vulnerabilities, exploit details,
+credentials, or sensitive scan results publicly.
-Maintainers review issues and carry accepted changes into the canonical source.
+If a scan finds a vulnerability in another project, report it to that
+project's maintainers through their security policy.
## Dependency and release maintenance