Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/`
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
15 changes: 8 additions & 7 deletions docs/developer-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <your-repo-url>
cd <your-repo>
./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.
Expand All @@ -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:

Expand Down Expand Up @@ -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.
Loading