https://github.com/asphyx0r/git-starter-kit
A minimal, reusable starter repository for Git and GitHub projects.
https://github.com/asphyx0r/git-starter-kit
git
Last synced: 13 days ago
JSON representation
A minimal, reusable starter repository for Git and GitHub projects.
- Host: GitHub
- URL: https://github.com/asphyx0r/git-starter-kit
- Owner: asphyx0r
- License: mit
- Created: 2026-06-17T19:15:50.000Z (19 days ago)
- Default Branch: master
- Last Pushed: 2026-06-17T22:25:58.000Z (19 days ago)
- Last Synced: 2026-06-18T00:14:39.690Z (19 days ago)
- Topics: git
- Homepage:
- Size: 14.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: SUPPORT.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Git Starter Kit
A minimal, reusable starter repository for Git and GitHub projects.
## Features
- Git and editor conventions for repository consistency.
- Generic ignore rules for local files, secrets, caches, and build outputs.
- Commit message guidance with a reusable Git commit template and strict
commitlint rules.
- Lightweight spelling configuration for documentation and repository files.
- Coding-agent instructions for cautious, verifiable repository changes.
- VS Code workspace recommendations for consistent local editing.
- Repository file inventory in `docs/repository-files.md`.
- Reusable templates for README, changelog, contributing, code of conduct,
security, support, environment, Git, Codex, and release notes files.
- GitHub community files for pull requests, issues, conduct, and support.
- GitHub Actions workflow for lightweight Markdown, spelling, script, and
configuration audits.
- Shared local and CI repository audit script for release readiness checks.
- Release package automation for exports enriched with coding-agent rules.
- Interactive Git initialization scripts for PowerShell and Bash.
## Installation
Use this repository as a starting point for a new project.
```bash
git clone
cd
```
## Usage
```bash
git status
git config commit.template .gitmessage
```
Copy files from `templates/` when starting a new project and replace the
placeholder values with project-specific content.
Use the GitHub templates in `.github/` to keep issues and pull requests
reviewable with minimal process.
Run the same audit suite locally that GitHub Actions runs:
```bash
bash scripts/repository-audit.sh
```
Do not create a release tag or GitHub release if this local audit fails. The
script bootstraps `codespell` 2.4.2 in a temporary Python target and
requires the same tools as CI, including `shellcheck`, `pwsh`, `python`,
`node`, `git`, and `npx`.
Published releases can attach a generated ZIP package that overlays a resolved
`agent-coding-rules` release and records the requested and resolved source in
`_agent-rules-source.json`. See [Release Package](docs/release-package.md) for
automatic and manual usage.
Automatic release packages use the latest published full `agent-coding-rules`
release. Manual runs accept `latest` or a SemVer agent-rules tag. When `latest`
is used, the generated manifest records both the requested `latest` reference
and the resolved SemVer tag.
Initialize a target repository with an explicit confirmation prompt:
```bash
bash scripts/git-init.sh --path ../example-app --tag v1.0.0
```
```powershell
powershell -NoProfile -File scripts\git-init.ps1 --path ..\example-app --tag v1.0.0
```
Both scripts preview the files Git can commit before creating target `.git`
metadata. If commit confirmation is declined, the target directory is left
uninitialized.
Use `--remote ` when the initialized repository should add `origin` and
push `main` with tags. When `--remote` is omitted, the scripts do not push.
Run either script without arguments, or with `--help`, to show usage.
## Contributing
Keep changes minimal, generic, and directly useful for reusable Git/GitHub
project setup.
Please make sure to update `docs/repository-files.md` when repository files
are added or changed.
## Authors
- Repository maintainers
## License
[MIT](LICENSE)