Merge pull request #17 from OpenZeppelin/further-refine-docs-integrate-deepwiki

Improve documentation and add community standards files

Author: CallMeGwei

CODE_OF_CONDUCT.md

@@ -0,0 +1,127 @@
+# 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 identity
+and 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 on [Telegram](https://t.me/openzeppelin_tg/2).
+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).
+
+[homepage]: https://www.contributor-covenant.org
+
+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.

README.md

@@ -7,7 +7,7 @@
 ## 🚀 Features
 
 - **Extensible SDK**: Build custom detectors with AST traversal, symbol resolution, and helper macros.
-- **Out-of-the-box Detectors**: Prebuilt checks for common pitfalls like authorization issues, unchecked transfers, and more.
+- **Out-of-the-box Detectors**: Prebuilt checks for common pitfalls like improper TTL extension, contract panics, and unsafe temporary storage usage.
 - **CLI Scanner**: `soroban-scanner` command-line tool for running detectors against your codebase.
 - **CI/CD Ready**: Easily integrate into GitHub Actions, GitLab CI, or other pipelines.
 - **OpenZeppelin Inspector Compatible**: Fully ready to be used as a custom scanner with OpenZeppelin Inspector.
@@ -64,7 +64,7 @@ soroban-scanner scan path/to/your/contracts --load path/to/libmy_detector.so
 
 ## 📝 Writing Custom Detectors
 
-Leverage the [SDK Documentation](docs/overview.md) to author your own detectors:
+Leverage the [SDK Getting Started Documentation](docs/getting_started.md) to author your own detectors:
 
 - AST helpers for traversing Rust code.
 - Symbol table utilities for resolving types and references.
@@ -74,7 +74,6 @@ Leverage the [SDK Documentation](docs/overview.md) to author your own detectors:
 
 Find detailed docs for developing and contributing:
 
-- [Project Overview](docs/overview.md)
 - [Getting Started](docs/getting_started.md)
 - [Contributing](docs/contributing.md)
 

SECURITY.md

@@ -0,0 +1,37 @@
+# Security Policy
+
+Security vulnerabilities should be [disclosed](#reporting-a-vulnerability) by email to security@openzeppelin.com.
+
+To make your support policy require less maintenance, you can simplify the table and description by automatically tying support to the most recent major version. Here’s a revised version:
+
+---
+
+## Supported Versions
+
+Only the latest **major** version is supported and receives security updates. Alpha, Beta, and Release Candidate versions are not supported.
+
+Security patches are released for the latest minor and patch version of the current major release.
+
+Only critical severity bug fixes may be backported to earlier major versions.
+
+| Version      | Supported |
+| ------------ | --------- |
+| Latest major | ✅         |
+| Older majors | ❌         |
+
+
+## Reporting a Vulnerability
+
+We're extremely grateful for security researchers and users that report vulnerabilities to us.
+All reports are thoroughly investigated by the project's security team.
+
+Vulnerabilities are reported privately via GitHub's [Security Advisories](https://docs.github.com/en/code-security/security-advisories) feature.
+Please use the following link to submit your vulnerability: [Report a vulnerability](https://github.com/openzeppelin/soroban-security-detectors-sdk/security/advisories/new)
+
+Please see
+[Privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability)
+for more information on how to submit a vulnerability using GitHub's interface.
+
+## Legal
+
+OpenZeppelin Soroban Security Detectors SDK is made available under the GNU AGPL 3.0 License, which disclaims all warranties in relation to the project and which limits the liability of those that contribute and maintain the project, including OpenZeppelin. Your use of the project is also governed by the terms found at www.openzeppelin.com/tos (the "Terms"). As set out in the Terms, you are solely responsible for any use of OpenZeppelin Soroban Security Detectors SDK and you assume all risks associated with any such use. This Security Policy in no way evidences or represents an on-going duty by any contributor, including OpenZeppelin, to correct any flaws or alert you to all or any of the potential risks of utilizing the project.