Skip to content
aglaboPublic

About

No description, website, or topics provided.

Resources

Code of conduct

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

title .github - Shared Development Infrastructure
description Common development infrastructure ensuring OSS quality through automation - Configuration as Truth

English | 日本語

.github Shared Development Infrastructure

CI Test All

OSS Quality Assurance Through Automation - Enforce Quality via Configuration, Not Documentation

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.

📖 Purpose of This Repository

Problems Solved

  • Inconsistent code style
  • Varying quality of commit messages
  • Security risks (accidental commits of secrets)
  • Increased review burden
  • Documentation maintenance overhead

Approach

  1. Configuration as Truth - Rules live in config files, no documentation needed
  2. Automate Everything - Formatters, linters, and hooks prevent issues before they occur
  3. AI-Powered Workflow - Commit messages and documentation are AI-generated
  4. Zero Manual Checks - Two-layer defense with local hooks and CI/CD

🏗 Repository Structure

Core Features

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

Configuration Files

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

🚀 How to Use

1. Setup

# 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

2. Daily Usage

# 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

3. Using Templates

  • 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)
  • PR Creation: Checklist template automatically applied when opening a PR

📋 Important Usage Rules

Prohibited Actions

  • 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

Commit Types

Standard Types:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation
  • chore: Maintenance tasks
  • test: Tests
  • refactor: Refactoring
  • perf: Performance improvements
  • ci: CI/CD changes

Custom Types:

  • config: Configuration changes
  • release: Releases
  • merge: Merges
  • build: Build system
  • style: Style changes
  • deps: Dependency updates

📚 Detailed Information

For technical details and AI development guide, refer to CLAUDE.md.

Community Guidelines

📄 License

This project is licensed under the MIT License.

Copyright (c) 2025- aglabo

🙏 Thanks

This repository was created and maintained with the support of AI agent assistants:

  • 🤖 Kobeni
  • 🤖 Tsumugi
  • 🤖 Elpha

About

No description, website, or topics provided.

Resources

Code of conduct

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages