diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b80fa25..a20566e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,6 +24,6 @@ Thanks for your interest in contributing. ## Local automation defaults -- Bootstrap: `./scripts/bootstrap.sh` +- Bootstrap: `bash scripts/bootstrap.sh` - Setup guide: `docs/developer-setup.md` - CI workflows: `.github/workflows/` diff --git a/README.md b/README.md index ea39342..ab4ed57 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,32 @@ See `docs/REPOSITORY_STANDARDS.md` for reusable naming and governance convention ## Suggested next steps -- Add CI workflows in `.github/workflows/`. -- Add language/tool-specific linting and formatting. -- Add architecture and operations documentation in `docs/`. +- Review prebuilt GitHub Actions workflows in `.github/workflows/` and enable commands for your stack. +- Add language/tool-specific linting, formatting, and tests as your project grows. +- Add project-specific architecture and operations documentation in `docs/`. +- Configure `release.yml` for semantic release PRs/tags if you publish artifacts. + +## Repository layout + +``` +.github/ + ISSUE_TEMPLATE/ + workflows/ + PULL_REQUEST_TEMPLATE.md + CODEOWNERS +CHANGELOG.md +CODE_OF_CONDUCT.md +CONTRIBUTING.md +LICENSE +SECURITY.md +docs/ +scripts/ +``` + +## Automation included + +- Reusable quality workflow: `.github/workflows/reusable-quality.yml` +- CI entry workflow: `.github/workflows/ci.yml` +- Release automation workflow: `.github/workflows/release.yml` +- Bootstrap script: `scripts/bootstrap.sh` +- Developer setup guide: `docs/developer-setup.md` diff --git a/docs/developer-setup.md b/docs/developer-setup.md index 2f866c0..a2f2cfe 100644 --- a/docs/developer-setup.md +++ b/docs/developer-setup.md @@ -5,15 +5,16 @@ This guide provides generic onboarding defaults intended for template-based repo ## 1) Prerequisites - Git 2.40+ -- A language runtime/toolchain for your project (Node, Python, Go, etc.) -- A package manager (`npm`, `pnpm`, `pip`, `poetry`, `go`, etc.) +- Bash or another POSIX-compatible shell for helper scripts +- A language runtime/toolchain for your project such as Node, Python, Go, Rust, or similar +- A package manager such as npm, pnpm, pip, poetry, go, or cargo ## 2) Bootstrap locally ```bash git clone cd -./scripts/bootstrap.sh +bash scripts/bootstrap.sh ``` 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 The repository ships with: -- `.github/workflows/reusable-quality.yml` (reusable workflow) -- `.github/workflows/ci.yml` (default entry workflow) -- `.github/workflows/release.yml` (semantic release PR/tag automation) +- `.github/workflows/reusable-quality.yml` as the reusable workflow +- `.github/workflows/ci.yml` as the default entry workflow +- `.github/workflows/release.yml` for release PR and tag automation In `ci.yml`, enable checks by setting: @@ -63,7 +64,7 @@ with: ## 6) Lightweight automation standards - Keep workflows minimal and composable. -- Prefer reusable workflows (`workflow_call`) over duplicated YAML. +- Prefer reusable workflows over duplicated YAML. - Avoid stack-specific assumptions in template defaults. - Keep commands configurable through workflow inputs. - Fail fast in CI and keep logs clear.