Skip to content

docs: drop ecommerce integration references #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cblanc wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: drop ecommerce integration references #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db8393c
style(agents): normalize markdown formatting
cblanc Jul 21, 2026
4e356f7
docs: drop ecommerce integration references
cblanc Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 11 additions & 12 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,22 +63,22 @@ Two markdown templates live in `.github/ISSUE_TEMPLATE/`:

Both are plain markdown. `gh issue create --template <name>` opens an editor pre-filled with the template; for non-interactive use, render the body yourself and pass `--body`.

The `.yml` issue *forms* in the same directory are for the GitHub web UI only — **`gh` and the API ignore them**. Use the `.md` templates for programmatic filing.
The `.yml` issue _forms_ in the same directory are for the GitHub web UI only — **`gh` and the API ignore them**. Use the `.md` templates for programmatic filing.

## Required fields

These are the fields a triager needs to act on a bug. Agents should populate all of them:

| Field | Required | Notes |
|---|---|---|
| Title | yes | Prefix with `[bug]` or `[feature]`. Be specific (mention the command, endpoint, or library affected). |
| Product | yes | Use the canonical labels (see below). |
| Version | yes (bugs) | Package version, API version, or commit SHA. |
| What happened | yes (bugs) | Concrete description of observed behaviour. |
| Expected | yes (bugs) | What should have happened. |
| Steps to reproduce | yes (bugs) | Minimal repro. Redact secrets. |
| Problem | yes (features) | Underlying problem, not the solution. |
| Proposed solution | yes (features) | Specific behaviour you want. |
| Field | Required | Notes |
| ------------------ | -------------- | ----------------------------------------------------------------------------------------------------- |
| Title | yes | Prefix with `[bug]` or `[feature]`. Be specific (mention the command, endpoint, or library affected). |
| Product | yes | Use the canonical labels (see below). |
| Version | yes (bugs) | Package version, API version, or commit SHA. |
| What happened | yes (bugs) | Concrete description of observed behaviour. |
| Expected | yes (bugs) | What should have happened. |
| Steps to reproduce | yes (bugs) | Minimal repro. Redact secrets. |
| Problem | yes (features) | Underlying problem, not the solution. |
| Proposed solution | yes (features) | Specific behaviour you want. |

## Product labels

Expand All @@ -95,7 +95,6 @@ Pick exactly one in the **Product** section. Canonical strings:
## What does NOT belong here

- **Account, billing, sensitive issues** → email `support@ideal-postcodes.co.uk`. Do not file public issues with credentials, invoices, or PII.
- **Ecommerce integration bugs** (`woocommerce`, `magento`, `shopify`, `bigcommerce-app`, `salesforce`) → file in their own repos under `ideal-postcodes/<integration>`.

If unsure whether something belongs, file with product = "Other / not sure" and triage will redirect.

Expand Down
2 changes: 0 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@ Use it to:
- **Account, billing, or sensitive issues** → email [support@ideal-postcodes.co.uk](mailto:support@ideal-postcodes.co.uk).
**Do not post API keys, user tokens, addresses, or other personal data here.** Issues are public.
- **Security vulnerabilities** → see [SECURITY.md](./SECURITY.md). Do not file them publicly.
- **Ecommerce integrations** — these have their own public repos:
- [`woocommerce`](https://github.com/ideal-postcodes/woocommerce) · [`magento`](https://github.com/ideal-postcodes/magento) · [`shopify`](https://github.com/ideal-postcodes/shopify) · [`bigcommerce-app`](https://github.com/ideal-postcodes/bigcommerce-app) · [`salesforce`](https://github.com/ideal-postcodes/salesforce)

## Filing an issue

Expand Down
4 changes: 0 additions & 4 deletions SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ In scope — the products this tracker covers:
- `@ideal-postcodes/skills`
- [docs.ideal-postcodes.co.uk](https://docs.ideal-postcodes.co.uk)

Out of scope — report in the relevant repo:

- Ecommerce integrations: [`woocommerce`](https://github.com/ideal-postcodes/woocommerce), [`magento`](https://github.com/ideal-postcodes/magento), [`shopify`](https://github.com/ideal-postcodes/shopify), [`bigcommerce-app`](https://github.com/ideal-postcodes/bigcommerce-app), [`salesforce`](https://github.com/ideal-postcodes/salesforce)

## Please don't

- Post vulnerabilities, exploits, or PoCs in public issues or PRs.
Expand Down