Skip to content

MrScripty/Coding-Standards

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Standards Library

Reusable coding, commit, architecture, tooling, and documentation standards that can be copied to any project.

Quick Start

  1. Copy this entire /standards/ directory to your project root
  2. Read each document and adapt the examples to your tech stack
  3. Copy templates from /standards/templates/ to your project root
  4. Copy templates/check-decision-traceability.sh to scripts/ and enable the decision-traceability command in your hook config
  5. Reference these standards in your project's main README

Documents

Document Purpose When to Use
CODING-STANDARDS.md Code organization, file limits, layering, service independence, runtime wiring guidance Setting up any new codebase
TESTING-STANDARDS.md Test placement strategy, naming, coverage, and cross-layer verification guidance Writing maintainable tests
COMMIT-STANDARDS.md Git workflow, conventional commits, agent footers Any project using version control
ARCHITECTURE-PATTERNS.md System design patterns, monorepo package roles, executable contracts, composition roots, and resilient workflow coordination Multi-layer, client-server, monorepo, or service-oriented apps
TOOLING-STANDARDS.md Linting, hooks, automation Enforcing code quality
FRONTEND-STANDARDS.md Declarative rendering, UI synchronization, frontend testing/tooling conventions Web, desktop UI, and component-heavy frontend codebases
DOCUMENTATION-STANDARDS.md README requirements, comments, algorithm docs Maintaining readable codebases
SECURITY-STANDARDS.md Boundary validation, path safety, input sanitization, network transport safety Apps handling user input, file paths, or local IPC
CONCURRENCY-STANDARDS.md Async/threading patterns, async task lifecycle, mutex selection Multi-threaded or async applications
CROSS-PLATFORM-STANDARDS.md Platform abstraction, file system conventions, CI matrix Apps targeting multiple OS platforms
INTEROP-STANDARDS.md FFI safety, cross-language boundaries, contract maintenance Multi-language or native interop projects
DEPENDENCY-STANDARDS.md Dependency evaluation, versioning, auditing, and minimization Adding or reviewing third-party packages
PLAN-STANDARDS.md Planning workflow, milestones, re-plan triggers, and completion summaries Multi-file, cross-layer, or staged implementation work
LAUNCHER-STANDARDS.md launcher.sh contract, lifecycle flags, dependency checks, and app startup Standardizing app entry points and setup workflows
LANGUAGE-BINDINGS-STANDARDS.md Binding architecture, FFI wrapper design, code generation, type mapping Exposing a core library to multiple target languages
RELEASE-STANDARDS.md Versioning, changelogs, release artifacts, CI/CD release pipelines Shipping software to users or downstream consumers
ACCESSIBILITY-STANDARDS.md Semantic HTML, keyboard interaction, ARIA, a11y linting UI components in web or desktop apps

Templates

Ready-to-use configuration files in /templates/:

Template Purpose
README-TEMPLATE.md Directory documentation template
PLAN-TEMPLATE.md Implementation plan template
PULL_REQUEST_TEMPLATE.md PR checklist for decision traceability
check-decision-traceability.sh CI/hook script to enforce README/ADR decision updates
lefthook.yml Pre-commit hook configuration
.editorconfig Editor formatting settings

Customization

These standards are intentionally generic. When adopting them:

  1. Replace placeholders - Look for [YOUR-...] markers
  2. Add tech-specific rules - Extend with language-specific conventions
  3. Define your scopes - Map commit scopes to your project structure
  4. Configure tooling - Adapt hook commands to your build tools

License

These standards are provided as-is for free use in any project.

About

Pumas generic md coding agent guidance

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages