diff --git a/README.md b/README.md index 9b8b238..aa7bbc7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,8 @@ # Agentforce Vibes Library -Salesforce's official repository of agent skills for app building. It spans Agentforce agents, Lightning apps, Flow, Apex, SOQL, LWC, UI bundles, objects and fields, permission sets, and moreโ€”and we're just getting started. +This repository provides a curated collection of Salesforce agent skills for building applications. It includes skills for Agentforce agents, Lightning apps, Flow, Apex, SOQL, Lightning Web Components (LWC), UI bundles, objects and fields, permission sets, and related areas. -Optimized for Agentforce Vibes. Compatible with all AI tools that support skills. - -## ๐Ÿ“š About - -This repository curates Salesforce app building skills from Salesforce and the entire community. +The skills are contributed by Salesforce and the broader community. Itโ€™s optimized for Agentforce Vibes and can be used with any AI tool that supports skills. ## ๐Ÿ—‚๏ธ Structure @@ -27,46 +23,49 @@ afv-library/ ## ๐Ÿš€ Usage -| **Tool** | **Do This** | +| **Tool** | **Usage** | |----------|-------------| | **Agentforce Vibes** | Skills are auto-installed and auto-updated | -| **Claude Code, Codex, Gemini CLI, OpenCode, etc** | `npx skills add forcedotcom/afv-library` | - +| **OpenCode, Claude Code, Codex, Cursor, [more](https://agentskills.io/)** | `npx skills add forcedotcom/afv-library` | ## ๐Ÿ“ฆ Samples -The `samples/` folder contains synced sample apps. For example, `samples/ui-bundle-template-app-react-sample-b2e/` is kept in sync with the npm package `@salesforce/ui-bundle-template-app-react-sample-b2e` (nightly and on manual trigger via GitHub Actions). To run the same sync locally from the repo root: +The `samples/` folder contains synced sample apps. For example, `samples/ui-bundle-template-app-react-sample-b2e/` tracks the npm package `@salesforce/ui-bundle-template-app-react-sample-b2e` (nightly and on manual trigger via GitHub Actions). + +To run the same sync locally from the repository root: ```bash npm install npm run sync-react-b2e-sample ``` -The GitHub Action runs these same commands and opens a PR only when the npm package version has changed. See [samples/README.md](samples/README.md) for details. - +The GitHub Action runs the same commands and opens a pull request when the npm package version changes. For more information, see [samples/README.md](samples/README.md). ## ๐Ÿ› ๏ธ Agent Skills -Agent Skills are modular capabilities that bundle executable workflows, scripts, and reference materials into self-contained directories. This repository follows the open [Agent Skills specification](https://agentskills.io/) and is usable by all AI tools that support skills: Claude Code, Codex, Gemini CLI, OpenCode, etc. +Agent Skills package executable workflows, scripts, and reference material into self-contained directories. This repository follows the open [Agent Skills specification](https://agentskills.io/) and can be used with OpenCode, Claude Code, Codex, Cursor, and other tools that support skills. ### Directory Structure -Each skill is a folder containing: -- `SKILL.md` (required) - instructions + YAML frontmatter -- `scripts/` (optional) - executable Python/Bash/JS -- `references/` (optional) - additional documentation -- `assets/` (optional) - templates, schemas, lookup data - +Each skill is a folder that can include: +- `SKILL.md` (required): Instructions and YAML front matter. +- `scripts/` (optional): Executable scripts (For example, Python, Bash, or JavaScript). +- `references/` (optional): Extra reference documentation. +- `assets/` (optional): Templates, schemas, and lookup data ## ๐Ÿค Contributing -See [Contributing](./CONTRIBUTING.md) for complete details. - +See [Contributing](./CONTRIBUTING.md). ## ๐Ÿ’ฌ Feedback -Found an issue or have a suggestion? -- Open an issue in GitHub -- Suggest improvements via pull request -- Start a discussion in GitHub Discussions or the pull request thread +- Open an issue in this repository +- Open a pull request with suggested changes +- Use GitHub Discussions or the pull request thread for broader conversation +## Project Governance & Support + +- [License](./LICENSE.txt) +- [Code of Conduct](./CODE_OF_CONDUCT.md) +- [Contributing](./CONTRIBUTING.md) +- [Security](./SECURITY.md) diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..d7423e9 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,33 @@ +# Security + +## Reporting a Vulnerability + +We take the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations. + +If you believe you have found a security vulnerability, please report it to us as described below. + +**Please do not report security vulnerabilities through public GitHub issues.** + +Instead, please report them via email to [security@salesforce.com](mailto:security@salesforce.com) as soon as it is discovered. This repo limits its runtime dependencies in order to reduce the total cost of ownership as much as can be, but all consumers should remain vigilant and have their security stakeholders review all third-party products (3PP) like this one and their dependencies. + +You should receive a response within 48 hours. If for some reason you do not, please follow up via email to ensure we received your original message. + +Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: + +- Type of issue (buffer overflow, SQL injection, cross-site scripting, etc.) +- Full paths of source file(s) related to the vulnerability +- The location of the affected source code (tag/branch/commit or direct URL) +- Any special configuration required to reproduce the issue +- Step-by-step instructions to reproduce the issue +- Proof-of-concept or exploit code (if possible) +- Impact of the issue, including how an attacker might exploit it + +This information will help us triage your report more quickly. + +## Preferred Languages + +We prefer all communications to be in English. + +## Policy + +Salesforce follows the principle of [Responsible Disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure). \ No newline at end of file