diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18b07d9..6597220 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,7 +39,7 @@ Every asset type in this repo — Studio Projects, Golden Configurations, OpenAP - [ ] Free from errors. - [ ] Includes enough detail so that others can easily replicate the setup. - [ ] Clearly explains what your contribution does, why it's valuable, and how it improves or complements existing functionality. -- [ ] No sensitive or private data included (see [`STANDARDS.md`](./STANDARDS.md#repo-wide-requirements)). +- [ ] No sensitive or private data included, and no customer/partner names anywhere (see [`STANDARDS.md`](./STANDARDS.md#repo-wide-requirements)). - [ ] Root [`README.md`](./README.md) updated if your contribution adds a new vendor, a new product under an existing vendor, or a new asset type (update the Vendor Index and/or Asset Type table). - [ ] Reviewed against the relevant sections of [`STANDARDS.md`](./STANDARDS.md) for the asset type(s) you're contributing. diff --git a/STANDARDS.md b/STANDARDS.md index 792be89..04ce8fa 100644 --- a/STANDARDS.md +++ b/STANDARDS.md @@ -57,6 +57,7 @@ Imported into Itential Platform as Integration Models. ## Repo-Wide Requirements - **No Sensitive Data**: Ensure your contribution does not contain any sensitive or private data (e.g., API keys, passwords, personal information). +- **No Customer/Partner Names**: Never mention a specific customer, partner, or internal deal/project name anywhere in this repo — not in README content, OpenAPI spec fields, Studio Project names/descriptions, commit messages, or PR descriptions/comments. This is community-contributed, vendor-facing content; keep it generic (e.g. "a customer request" or no attribution at all, not the customer's name). - **Product README structure**: Each product folder's `README.md` should keep a plain `# {Product}` title but skip a separate `## Overview` heading and any "Assets for the Itential Platform" boilerplate — the description paragraph(s) flow directly under the title. Keep that intro **product-agnostic**: describe the vendor/product itself, not the specifics of any one asset it ships with. Detail that's specific to one asset (e.g. a Studio Project's workflow count, folder count, or category breakdown) belongs under that asset's own heading (e.g. `## Studio Projects`), not in the top-level intro. Avoid superlative/marketing language ("the premier...", "industry-leading...") since competing vendors coexist in this repo. See NetBox's or GitHub's `README.md` for the pattern. - **No generic import instructions**: Don't restate how to import a Studio Project, OpenAPI spec, Golden Configuration, or device driver in a product's own README (e.g. "Import via Automation Studio > Projects > Import") — those generic click-paths already live once in the root [`README.md`](./README.md)'s Getting Started section. A product README's asset sections should only cover what's specific to that product: which Integration instance name a workflow expects, credential/config setup, etc. - **Branding**: Refer to the products as "Itential Platform" and "Itential Gateway" (or "Platform"/"Gateway" for brevity once already introduced, or a specific version like "P6" or "IG5" when relevant) — never the retired abbreviations "IAP" or "IAG".