https://github.com/fini-net/template-repo
Automated GitHub workflow template: community standards, just recipes for PR lifecycle, AI reviews (Copilot/Claude), and template sync system
https://github.com/fini-net/template-repo
compliance github github-repository template template-generic-repo template-repository
Last synced: about 2 months ago
JSON representation
Automated GitHub workflow template: community standards, just recipes for PR lifecycle, AI reviews (Copilot/Claude), and template sync system
- Host: GitHub
- URL: https://github.com/fini-net/template-repo
- Owner: fini-net
- License: gpl-2.0
- Created: 2025-05-29T04:58:32.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2026-03-21T19:36:07.000Z (2 months ago)
- Last Synced: 2026-03-22T07:44:56.943Z (about 2 months ago)
- Topics: compliance, github, github-repository, template, template-generic-repo, template-repository
- Language: Just
- Homepage:
- Size: 4.35 MB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# FINI template-repo
A good template for github repos with best practices adoption.
## Template Features
### GitHub Community Standards
- ✅ [All github community standards are checked off](https://github.com/fini-net/template-repo/community)
- ✅ This [README](README) with badges and banner
- ✅ [Contributor Covenant](https://www.contributor-covenant.org)-based Code of Conduct
- ✅ [Contributing Guide](.github/CONTRIBUTING.md) includes a step-by-step guide to our [command line development process](.github/CONTRIBUTING.md#development-process)
- ✅ [GPL2](LICENSE) license
- ✅ [Security Policy](.github/SECURITY.md)
- ✅ [Issue Templates](.github/ISSUE_TEMPLATE/)
- ✅ [PR Template](.github/pull_request_template.md)
- ✅ [gitattributes](.gitattributes) based on [gitattributes](https://github.com/gitattributes/gitattributes)
- ✅ [gitignore](.gitignore) with comments
- ✅ [CODEOWNERS](.github/CODEOWNERS) that is self-documented
### Modular Justfile Architecture
The [justfile](justfile) imports 8 modules from the [.just/](.just/) directory for a clean, maintainable workflow:
- ✅ [gh-process.just](.just/gh-process.just) - Complete PR lifecycle automation with smart check polling and AI review integration
- ✅ [compliance.just](.just/compliance.just) - Repository health checks validating all GitHub community standards and branch protection
- ✅ [shellcheck.just](.just/shellcheck.just) - Bash script linting that extracts and validates all scripts in just recipes
- ✅ [cue-verify.just](.just/cue-verify.just) - Three-stage validation of [.repo.toml](.repo.toml) structure, flags, and GitHub sync
- ✅ [claude.just](.just/claude.just) - Claude Code permission management with canonical sorting and structure validation
- ✅ [repo-toml.just](.just/repo-toml.just) - Metadata extraction that generates shell variables from repository configuration
- ✅ [template-sync.just](.just/template-sync.just) - Safe template updates preserving local customizations via multi-version checksums
- ✅ [pr-hook.just](.just/pr-hook.just) - Optional pre-PR hooks for project-specific automation
### Repository Metadata System
- ✅ [.repo.toml](.repo.toml) - Centralized configuration with description, topics, URLs, and feature flags
- ✅ [Cue schema validation](docs/repo-toml.cue) - Three-stage verification checks structure, validates flags against actual files, and syncs GitHub metadata
- ✅ Automatic shell variable generation - The `repo_toml_generate` recipe exports TOML data as sourceable bash variables
- ✅ GitHub metadata synchronization - `cue-sync-from-github` pulls description and topics from GitHub API
### GitHub Actions
Eight workflows handle automation and quality:
- ✅ [Auto-assign](.github/workflows/auto-assign.yml) - Automatically assigns issues and PRs to maintainers
- ✅ [Checkov](.github/workflows/checkov.yml) - Security scanning for GitHub Actions workflows with SARIF output
- ✅ [Markdownlint](.github/workflows/markdownlint.yml) - Enforces markdown standards across all docs
- ✅ [Actionlint](.github/workflows/actionlint.yml) - Lints GitHub Actions workflow files
- ✅ [Zizmor](.github/workflows/zizmor.yml) - Static security analysis for GitHub Actions workflows
- ✅ [Claude mention integration](.github/workflows/claude.yml) - Mentions Claude AI when appropriate
- ✅ [Claude Code review](.github/workflows/claude-code-review.yml) - AI-powered code review automation
- ✅ [Cue verification](.github/workflows/cue-verify.yml) - Validates `.repo.toml` format and flags
### AI-Enhanced Development
- ✅ Conditional AI review display - After PR checks complete, shows review comments based on `.repo.toml` flags
- ✅ GitHub Copilot review integration - Enable/disable with `copilot-review` flag
- ✅ Claude Code review integration - Enable/disable with `claude-review` flag
- ✅ Smart polling system - Waits up to 30 seconds for checks to start, then polls every 5 seconds for faster feedback
### Additional Features
- ✅ [Priority labels](https://github.com/fini-net/template-repo/labels) - Extra issue labels for better organization
- ✅ [Prerequisites installation](.just/lib/install-prerequisites.sh) - Script to install required tools
- ✅ Release automation - `just release ` creates GitHub releases with auto-generated notes and age monitoring
## Usage
1. To use this template, you can create a new repository by clicking on "Use this
template" button.
1. Remember to replace any `chicks-net`, `fini-net`, and `template-repo` references
with the right values for your project. (Github templates do not offer
variable substitution, but we still have to call them templates for some reason.)
1. Ditch the "Template Status", "Usage", and "Kudos" sections in the `README.md`.
`just clean_template` will give you a clean `/README.md`, and remove other files that are not required.
[Here is a nice checklist](https://github.com/jlcanovas/gh-best-practices-template/blob/main/guidelines.md)
of things to consider with a new repo.
## Keeping Your Derived Repo Up-to-Date
Pull updates to `.just/` modules from template-repo:
```bash
just update_from_template
```
Only unmodified files are updated. Local customizations are preserved.
Preview changes:
```bash
just checksums_verify # Check which files would update
just checksums_diff .just/gh-process.just # See specific changes
```
The update system uses multi-version checksum tracking to safely identify which files match known template versions. Files with local modifications are skipped and reported.
## Contributing
- [Code of Conduct](.github/CODE_OF_CONDUCT.md)
- [Contributing Guide](.github/CONTRIBUTING.md) includes a step-by-step guide to our
[development process](.github/CONTRIBUTING.md#development-process).
## Support & Security
- [Getting Support](.github/SUPPORT.md)
- [Security Policy](.github/SECURITY.md)
## License
I went with the [GPL2 license](LICENSE), but the MIT license is also worth considering.
## Other good template repos on github
- Jose Gracia Berenguer did a great job with their
[project-template](https://github.com/Josee9988/project-template)
repo. This looks like a student project, but it is one of the best
templates I've found on github.
- [Cookiecutter Data Science](https://github.com/drivendataorg/cookiecutter-data-science)
is cool, but it isn't actually a template repo.
- [gh-best-practices-template](https://github.com/jlcanovas/gh-best-practices-template)
is doing great at checking off all of the boxes. They've including funding and citations
which I haven't tried yet. I'm not a fan of how all of the Markdown files are in the
root directory. I definitely prefer stuffing those under `/.github` for a cleaner
root directory.
## Thanks
- I've really enjoyed building projects with [just](https://just.systems/man/en/).
- The [GitHub CLI](https://cli.github.com/) makes browser-free workflows not only
possible, but fun.