Skip to content

Commit f6133a5

Browse files
Clean DevEx template docs after stabilization
Document included automation and align bootstrap instructions after the DevEx workflow stabilization landed on main.
1 parent 5b54005 commit f6133a5

3 files changed

Lines changed: 38 additions & 11 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,6 @@ Thanks for your interest in contributing.
2424

2525
## Local automation defaults
2626

27-
- Bootstrap: `./scripts/bootstrap.sh`
27+
- Bootstrap: `bash scripts/bootstrap.sh`
2828
- Setup guide: `docs/developer-setup.md`
2929
- CI workflows: `.github/workflows/`

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,32 @@ See `docs/REPOSITORY_STANDARDS.md` for reusable naming and governance convention
6363

6464
## Suggested next steps
6565

66-
- Add CI workflows in `.github/workflows/`.
67-
- Add language/tool-specific linting and formatting.
68-
- Add architecture and operations documentation in `docs/`.
66+
- Review prebuilt GitHub Actions workflows in `.github/workflows/` and enable commands for your stack.
67+
- Add language/tool-specific linting, formatting, and tests as your project grows.
68+
- Add project-specific architecture and operations documentation in `docs/`.
69+
- Configure `release.yml` for semantic release PRs/tags if you publish artifacts.
70+
71+
## Repository layout
72+
73+
```
74+
.github/
75+
ISSUE_TEMPLATE/
76+
workflows/
77+
PULL_REQUEST_TEMPLATE.md
78+
CODEOWNERS
79+
CHANGELOG.md
80+
CODE_OF_CONDUCT.md
81+
CONTRIBUTING.md
82+
LICENSE
83+
SECURITY.md
84+
docs/
85+
scripts/
86+
```
87+
88+
## Automation included
89+
90+
- Reusable quality workflow: `.github/workflows/reusable-quality.yml`
91+
- CI entry workflow: `.github/workflows/ci.yml`
92+
- Release automation workflow: `.github/workflows/release.yml`
93+
- Bootstrap script: `scripts/bootstrap.sh`
94+
- Developer setup guide: `docs/developer-setup.md`

docs/developer-setup.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@ This guide provides generic onboarding defaults intended for template-based repo
55
## 1) Prerequisites
66

77
- Git 2.40+
8-
- A language runtime/toolchain for your project (Node, Python, Go, etc.)
9-
- A package manager (`npm`, `pnpm`, `pip`, `poetry`, `go`, etc.)
8+
- Bash or another POSIX-compatible shell for helper scripts
9+
- A language runtime/toolchain for your project such as Node, Python, Go, Rust, or similar
10+
- A package manager such as npm, pnpm, pip, poetry, go, or cargo
1011

1112
## 2) Bootstrap locally
1213

1314
```bash
1415
git clone <your-repo-url>
1516
cd <your-repo>
16-
./scripts/bootstrap.sh
17+
bash scripts/bootstrap.sh
1718
```
1819

1920
If your repository is not Node.js based, adapt `scripts/bootstrap.sh` to your stack and keep command names consistent with CI.
@@ -32,9 +33,9 @@ This template's reusable workflow can call any shell command, but these names im
3233

3334
The repository ships with:
3435

35-
- `.github/workflows/reusable-quality.yml` (reusable workflow)
36-
- `.github/workflows/ci.yml` (default entry workflow)
37-
- `.github/workflows/release.yml` (semantic release PR/tag automation)
36+
- `.github/workflows/reusable-quality.yml` as the reusable workflow
37+
- `.github/workflows/ci.yml` as the default entry workflow
38+
- `.github/workflows/release.yml` for release PR and tag automation
3839

3940
In `ci.yml`, enable checks by setting:
4041

@@ -63,7 +64,7 @@ with:
6364
## 6) Lightweight automation standards
6465

6566
- Keep workflows minimal and composable.
66-
- Prefer reusable workflows (`workflow_call`) over duplicated YAML.
67+
- Prefer reusable workflows over duplicated YAML.
6768
- Avoid stack-specific assumptions in template defaults.
6869
- Keep commands configurable through workflow inputs.
6970
- Fail fast in CI and keep logs clear.

0 commit comments

Comments
 (0)