| title | .github - Shared Development Infrastructure |
|---|---|
| description | Common development infrastructure ensuring OSS quality through automation - Configuration as Truth |
English | 日本語
This repository provides shared development infrastructure actively used in OSS projects. It ensures quality through automation rather than manual checks. Key features include Issue/PR templates, auto-formatting, linting, security scanning, and Git Hooks.
- Inconsistent code style
- Varying quality of commit messages
- Security risks (accidental commits of secrets)
- Increased review burden
- Documentation maintenance overhead
- Configuration as Truth - Rules live in config files, no documentation needed
- Automate Everything - Formatters, linters, and hooks prevent issues before they occur
- AI-Powered Workflow - Commit messages and documentation are AI-generated
- Zero Manual Checks - Two-layer defense with local hooks and CI/CD
| Category | Feature | What's Provided |
|---|---|---|
| Templates | Issue/PR | Bug reports, feature requests, PR checklist |
| Formatting | dprint | Auto-formatting for Markdown/JSON/YAML/TOML |
| Lint | markdownlint/textlint/cspell | Document quality checks, spell checking |
| Security | gitleaks/secretlint | Secret detection, commit blocking |
| Git Hooks | lefthook | Pre-commit automated checks |
| Commit | commitlint | Conventional Commits enforcement |
| CI/CD | GitHub Actions | Secret scanning, CodeQL, action tests |
| Category | Tool | Config File |
|---|---|---|
| Formatting | dprint | dprint.jsonc |
| EditorConfig | .editorconfig |
|
| Lint | markdownlint | configs/.markdownlint.yaml |
| textlint | configs/textlintrc.yaml |
|
| cspell | .vscode/cspell.json |
|
| Git Hooks | lefthook | lefthook.yml |
| Commit | commitlint | configs/commitlint.config.js |
| prepare-commit-msg | scripts/prepare-commit-msg.sh |
|
| Security | gitleaks | configs/gitleaks.toml |
| secretlint | configs/secretlint.config.yaml |
|
| CI/CD | Secret scan | .github/workflows/ci-secrets-scan.yml |
| CodeQL | .github/workflows/codeql-actions-only.yml |
# Place this repository in your project's .github/ directory
git clone https://github.com/atsushifx/.github.git
# Install Git Hooks
lefthook install
# Verify formatting configuration
dprint fmt# Write code → dprint auto-formats
# (.editorconfig applied on save)
# Commit → Hooks auto-check
git commit
# - gitleaks detects secrets
# - markdownlint/textlint check documents
# - commitlint validates messages
# - AI-generated messages prepared
# Push → CI performs final checks
git push-
Issue Creation: Template selection automatically available in repository's Issues tab
- Bug Report (
bug_report.yml) - Feature Request (
feature_request.yml) - General Topic (
open_topic.yml) - Release (
release.yml)
- Bug Report (
-
PR Creation: Checklist template automatically applied when opening a PR
- Don't bypass hooks with
--no-verify - Don't commit secrets (gitleaks will block)
- Don't manually format code (leave it to dprint)
- Follow Conventional Commits format
Standard Types:
feat: New featuresfix: Bug fixesdocs: Documentationchore: Maintenance taskstest: Testsrefactor: Refactoringperf: Performance improvementsci: CI/CD changes
Custom Types:
config: Configuration changesrelease: Releasesmerge: Mergesbuild: Build systemstyle: Style changesdeps: Dependency updates
For technical details and AI development guide, refer to CLAUDE.md.
- Code of Conduct - Community code of conduct
- Security Policy - Vulnerability reporting procedures
This project is licensed under the MIT License.
Copyright (c) 2025- aglabo
This repository was created and maintained with the support of AI agent assistants:
- 🤖 Kobeni
- 🤖 Tsumugi
- 🤖 Elpha