22
33This guide provides generic onboarding defaults intended for template-based repositories.
44
5+ For broader contributor workflow, dependency, debugging, validation, and coding standards, see ` docs/DEVEX.md ` .
6+
57## 1) Prerequisites
68
79- Git 2.40+
@@ -19,6 +21,8 @@ bash scripts/bootstrap.sh
1921
2022If your repository is not Node.js based, adapt ` scripts/bootstrap.sh ` to your stack and keep command names consistent with CI.
2123
24+ If the project needs runtime configuration, copy ` config/.env.example ` to your local environment file and replace placeholder values locally.
25+
2226## 3) Recommended task contract
2327
2428To keep automation portable, define task commands with predictable names:
@@ -29,7 +33,17 @@ To keep automation portable, define task commands with predictable names:
2933
3034This template's reusable workflow can call any shell command, but these names improve discoverability.
3135
32- ## 4) CI customization
36+ ## 4) Local validation
37+
38+ Run the reusable validation helper before opening a PR:
39+
40+ ``` bash
41+ bash scripts/validate.sh
42+ ```
43+
44+ Adapt this script as the project adopts a specific language stack.
45+
46+ ## 5) CI customization
3347
3448The repository ships with:
3549
@@ -54,14 +68,14 @@ with:
5468 test-command : npm test
5569` ` `
5670
57- ## 5 ) Branch and PR workflow
71+ ## 6 ) Branch and PR workflow
5872
59731. Create a branch from ` main`.
60742. Run local validation commands before opening a PR.
61753. Open a focused PR and include context for reviewers.
62764. Merge only when CI checks pass.
6377
64- # # 6 ) Lightweight automation standards
78+ # # 7 ) Lightweight automation standards
6579
6680- Keep workflows minimal and composable.
6781- Prefer reusable workflows over duplicated YAML.
0 commit comments