Skip to content

Commit 36249dc

Browse files
committed
chore: polish badges and contribution controls
Refresh README badges, scope code ownership to protected surfaces, improve provider contribution templates, and route Vercel deploys through GitHub environments.
1 parent 4216903 commit 36249dc

7 files changed

Lines changed: 78 additions & 7 deletions

File tree

.github/CODEOWNERS

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
* @jesseoue
2-
3-
# The hosted web app is maintainer-owned. External contributors should avoid
4-
# changing it unless coordinated with @jesseoue.
1+
# The hosted web app and repository automation are maintainer-owned.
2+
# Registry modules, provider adapters, recipes, presets, docs, and examples are
3+
# intentionally open for community and provider contributions through PRs.
54
apps/web/** @jesseoue
5+
.github/** @jesseoue
6+
vercel.json @jesseoue
7+
package.json @jesseoue
8+
pnpm-lock.yaml @jesseoue

.github/ISSUE_TEMPLATE/module_request.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,20 @@ body:
2222
attributes:
2323
label: Systems involved
2424
description: UI, routes, schemas, env, docs, tests, maintenance skills, providers.
25+
- type: dropdown
26+
id: readiness
27+
attributes:
28+
label: Expected readiness
29+
description: Is this a roadmap stub or an installable source module?
30+
options:
31+
- stub
32+
- experimental
33+
- ready
34+
- stable
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: workflow
39+
attributes:
40+
label: Recipe or install order
41+
description: Which recipe, preset, or install stage should include this module?

.github/ISSUE_TEMPLATE/provider_request.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,20 @@ body:
3232
attributes:
3333
label: Notes
3434
description: What should the adapter do?
35+
- type: textarea
36+
id: install-surface
37+
attributes:
38+
label: Install surface
39+
description: Which source files, routes, env vars, docs, checklist items, and maintenance skills should this adapter include?
40+
placeholder: "Client/helper files, webhook routes, console page, env keys, docs, tests/checklist, shared provider skill..."
41+
- type: dropdown
42+
id: readiness
43+
attributes:
44+
label: Expected readiness
45+
options:
46+
- stub
47+
- experimental
48+
- ready
49+
- stable
50+
validations:
51+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,24 @@
22

33
## Test Plan
44

5+
- [ ] `pnpm check`
56
- [ ] Typecheck
67
- [ ] Lint
78
- [ ] Tests
89
- [ ] Build
910
- [ ] Fresh install/demo path
1011

12+
## Registry Changes
13+
14+
- [ ] Module status is honest (`ready` has files, `stub` has no source payload)
15+
- [ ] Recipe or preset install order updated if this changes a workflow
16+
- [ ] Shared provider skill referenced when provider SDK/API behavior is involved
17+
- [ ] Generated registry output updated if manifests changed
18+
1119
## Public Safety
1220

1321
- [ ] No secrets or local env files
1422
- [ ] No private company/customer references
1523
- [ ] Docs updated
1624
- [ ] Maintenance skill updated if module behavior changed
17-
- [ ] Generated registry output updated if manifests changed
1825
- [ ] Screenshots/GIFs contain demo data only

.github/workflows/deploy-vercel.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@ jobs:
1919
deploy:
2020
runs-on: ubuntu-latest
2121
timeout-minutes: 20
22+
environment: ${{ inputs.environment }}
23+
concurrency:
24+
group: deploy-vercel-${{ inputs.environment }}
25+
cancel-in-progress: false
2226
env:
2327
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
2428
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}

CONTRIBUTING.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,26 @@ pnpm dev:web
2727
A module should include:
2828

2929
- `module.json`
30-
- source files or planned file paths
30+
- source files when the module is `ready`, `experimental`, or `stable`
3131
- `docs.md`
3232
- `skill/SKILL.md`
3333
- `tests/checklist.md`
3434

35+
Use `stub` for modules that document a real SaaS capability but do not install source yet. Use `ready` only when the module has installable source files and passes registry validation.
36+
37+
## Provider Adapters
38+
39+
Provider contributions are welcome. Keep adapters optional and focused:
40+
41+
- Add provider-specific code in its own module instead of coupling it to source-owned defaults.
42+
- Reference shared provider skills from `registry/skills/<provider>/SKILL.md` when possible.
43+
- Document required environment variables, dashboard resources, webhook setup, and smoke-test steps.
44+
- Do not commit provider credentials, project IDs, customer data, `.env*`, or generated local state.
45+
46+
## Recipes And Presets
47+
48+
Recipes explain install order and architecture. Presets install bundles. If your provider belongs in a larger workflow, update the relevant recipe or preset and regenerate `public/r`.
49+
3550
## Pull Requests
3651

3752
Each PR should focus on one phase or one module.

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,16 @@
33
Install production SaaS modules as editable source code.
44

55
[![CI](https://github.com/jesseoue/stackfoundry/actions/workflows/ci.yml/badge.svg)](https://github.com/jesseoue/stackfoundry/actions/workflows/ci.yml)
6+
[![CodeQL](https://github.com/jesseoue/stackfoundry/actions/workflows/codeql.yml/badge.svg)](https://github.com/jesseoue/stackfoundry/actions/workflows/codeql.yml)
7+
[![Dependency Review](https://github.com/jesseoue/stackfoundry/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/jesseoue/stackfoundry/actions/workflows/dependency-review.yml)
8+
[![Release](https://img.shields.io/github/v/release/jesseoue/stackfoundry?label=release)](https://github.com/jesseoue/stackfoundry/releases)
69
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
7-
[![Status: Experimental](https://img.shields.io/badge/status-experimental-orange.svg)](./ROADMAP.md)
10+
![Next.js](https://img.shields.io/badge/Next.js-16-black)
11+
![Vercel](https://img.shields.io/badge/deploy-Vercel-black)
12+
![Modules](https://img.shields.io/badge/modules-294-orange)
13+
![Recipes](https://img.shields.io/badge/recipes-9-purple)
14+
![Presets](https://img.shields.io/badge/presets-13-teal)
15+
![Inspired by shadcn](https://img.shields.io/badge/inspired%20by-shadcn-111111)
816

917
StackFoundry is a public source registry for the product plumbing most SaaS teams rebuild: billing, auth, API keys, webhooks, docs, analytics, notifications, operations, provider adapters, and launch readiness.
1018

0 commit comments

Comments
 (0)