Skip to content

Commit 029f471

Browse files
authored
chore: open-source readiness — fix repo metadata, add SECURITY/SUPPORT (#3)
Prep the repo for going public: - Fix package.json repository/bugs/homepage URLs (pointed at a non-existent github.com/bitbybit/marketing-cli slug) to github.com/BitByBit-B3/marketing. - Fix the BitByBit org link and the clone URL placeholder in the README. - Add SECURITY.md (private vuln reporting via GitHub advisories) and SUPPORT.md. - Rename root workspace package @bitbybit/marketing-cli -> @b3/marketing for scope consistency with the @b3/* packages. Verified: pnpm install --frozen-lockfile, typecheck, and the full test suite (104 tests, incl. brand-guard + catalog:check) all pass.
1 parent 59c93f4 commit 029f471

5 files changed

Lines changed: 99 additions & 6 deletions

File tree

CHANGELOG.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
44

55
The format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7+
## [Unreleased]
8+
9+
### Added
10+
11+
- `SECURITY.md` — private vulnerability reporting policy (GitHub Security Advisories).
12+
- `SUPPORT.md` — where to ask questions and file issues.
13+
14+
### Fixed
15+
16+
- Corrected `repository`, `bugs`, and `homepage` URLs in `package.json` to point at
17+
`github.com/BitByBit-B3/marketing` (they referenced a non-existent slug).
18+
- Fixed the BitByBit org link and the clone URL in the README.
19+
20+
### Changed
21+
22+
- Renamed the root workspace package to `@b3/marketing` for scope consistency with
23+
the `@b3/*` workspace packages.
24+
725
## [0.1.0] — 2026-05-19
826

927
Initial open-source release.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Agent-driven social images. Type a JSON brief, get an on-brand PNG.
44

5-
Ships themed for [BitByBit (B3)](https://github.com/bitbybit) — the team that built it. Fork the repo, edit `brand.config.ts`, and the same templates render in your brand.
5+
Ships themed for [BitByBit (B3)](https://github.com/BitByBit-B3) — the team that built it. Fork the repo, edit `brand.config.ts`, and the same templates render in your brand.
66

77
## Why this exists
88

@@ -13,7 +13,7 @@ Most AI image generation goes off-brand the second you stop watching. This tool
1313
Requirements: Node 22+, pnpm 9+ (brand-guard uses the still-experimental `node:fs/promises` glob, which lands as stable in Node 22).
1414

1515
```bash
16-
git clone <this-repo>
16+
git clone https://github.com/BitByBit-B3/marketing.git
1717
cd marketing
1818
pnpm install
1919
pnpm marketing render hero-card --data examples/hero-card.json --format square --out ./out

SECURITY.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Security Policy
2+
3+
## Supported versions
4+
5+
This project is pre-1.0 and ships from `main`. Security fixes land on `main` and
6+
in the latest release. Older tagged releases are not separately patched.
7+
8+
| Version | Supported |
9+
| ------- | --------- |
10+
| `main` / latest `0.x` ||
11+
| older `0.x` tags ||
12+
13+
## Reporting a vulnerability
14+
15+
**Please do not open a public issue for security problems.**
16+
17+
Report privately through GitHub's **["Report a vulnerability"](https://github.com/BitByBit-B3/marketing/security/advisories/new)**
18+
button (repository → **Security****Advisories**). If you can't use GitHub
19+
Security Advisories, email **engineering@bbyb.dev** with the details instead.
20+
21+
Please include:
22+
23+
- A description of the issue and its impact.
24+
- Steps to reproduce, ideally with a minimal JSON brief or command.
25+
- The version / commit and your environment (Node version, OS).
26+
27+
## What to expect
28+
29+
- We aim to acknowledge a report within **5 business days**.
30+
- We'll confirm the issue, work on a fix, and keep you updated on progress.
31+
- Once a fix is released, we're happy to credit you in the advisory unless you
32+
prefer to stay anonymous.
33+
34+
## Scope notes
35+
36+
This is a local, offline image-rendering CLI: it takes a JSON brief and bundled
37+
fonts and produces a PNG. It does not make network calls at runtime and does not
38+
handle user accounts or secrets. The most relevant concerns are things like
39+
denial-of-service or resource exhaustion from crafted input, or a way to make
40+
the renderer write outside its intended output path. Reports along those lines
41+
are especially welcome.

SUPPORT.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Support
2+
3+
Thanks for using the Marketing CLI. Here's the fastest way to get unstuck.
4+
5+
## Before you ask
6+
7+
- Read the [README](./README.md) — the Quickstart, **Errors**, and **How it works**
8+
sections cover most questions.
9+
- Run the built-in discovery commands:
10+
```bash
11+
pnpm marketing list # all templates and their formats
12+
pnpm marketing schema <template> # the exact JSON a template expects
13+
```
14+
- Most failures are reported as JSON on stdout with an `error.code` and an
15+
`error.hint`. Start there — the hint usually names the field to fix.
16+
17+
## Questions and ideas
18+
19+
- **How-to / usage questions:** open a [GitHub issue](https://github.com/BitByBit-B3/marketing/issues)
20+
using a clear title. Include the command you ran and the full JSON output.
21+
- **Bug reports:** use the **Bug report** issue template and include a **minimal
22+
reproducible JSON brief**, the command, and your Node version / OS.
23+
- **New template or format requests:** use the **Template request** issue
24+
template. We discuss design in the issue before any code (see
25+
[CONTRIBUTING.md](./CONTRIBUTING.md)).
26+
27+
## Security
28+
29+
Do **not** report security issues in public issues. Follow the
30+
[Security Policy](./SECURITY.md) instead.
31+
32+
## Conduct
33+
34+
All participation is covered by our [Code of Conduct](./CODE_OF_CONDUCT.md).

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@bitbybit/marketing-cli",
2+
"name": "@b3/marketing",
33
"version": "0.1.0",
44
"description": "Agent-driven, on-brand social images. Type a JSON brief, get a deterministic PNG.",
55
"license": "MIT",
@@ -11,12 +11,12 @@
1111
},
1212
"repository": {
1313
"type": "git",
14-
"url": "https://github.com/bitbybit/marketing-cli.git"
14+
"url": "https://github.com/BitByBit-B3/marketing.git"
1515
},
1616
"bugs": {
17-
"url": "https://github.com/bitbybit/marketing-cli/issues"
17+
"url": "https://github.com/BitByBit-B3/marketing/issues"
1818
},
19-
"homepage": "https://github.com/bitbybit/marketing-cli#readme",
19+
"homepage": "https://github.com/BitByBit-B3/marketing#readme",
2020
"keywords": [
2121
"marketing",
2222
"social-images",

0 commit comments

Comments
 (0)