Skip to content

Base project template for Intent Solutions repos. Standard directory structure, CI workflows, and documentation templates.

Notifications You must be signed in to change notification settings

intent-solutions-io/project-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

9 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Intent Solutions Project Template

Master template repository for all Intent Solutions projects with standardized documentation, SOPs, community standards, and development workflows.

Status: Production | Version: 4.0 (Doc-Filing v4.0) | Maintained by: Jeremy Longshore


🎯 Purpose

This repository is the single source of truth for:

  • βœ… Community Standards - CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md
  • βœ… Documentation System - Doc-Filing v4.0 standard
  • βœ… AAR Templates - After-Action Report format
  • βœ… Project Specs - Specification pack templates
  • βœ… Work Tracking - Beads + TaskID standards
  • βœ… SOPs - Standard Operating Procedures (GCP/Firebase, project start)

All other Intent Solutions projects pull standards FROM this repository.


πŸš€ Quick Start

Option 1: Create New Project from Template

# Via GitHub UI:
# 1. Go to https://github.com/intent-solutions-io/project-template
# 2. Click "Use this template" β†’ "Create a new repository"
# 3. Name your project and create

# Via CLI:
gh repo create my-new-project \
  --template intent-solutions-io/project-template \
  --private \
  --clone

cd my-new-project
bd ready  # Start Beads task tracking

Option 2: Sync Standards to Existing Project

cd ~/my-existing-project
~/000-projects/project-template/sync-from-template.sh

git add -A
git commit -m "chore: sync standards from project-template"
git push

πŸ“¦ What's Included

Root Files (Community Standards - MASTER versions)

  • CODE_OF_CONDUCT.md - Contributor Covenant Code of Conduct
  • CONTRIBUTING.md - Contribution guidelines and workflow
  • SECURITY.md - Security policy and vulnerability reporting
  • AGENTS.md - Agent configuration template
  • CLAUDE.md - Instructions for Claude Code AI assistant

000-docs/ Directory (Documentation Standards & Templates)

File Purpose
6767-a-DR-STND-document-filing-system-standard-v4.md Doc-Filing v4.0 - Naming convention, document types
6767-b-AA-TMPL-after-action-report-template.md AAR Template - Required sections, format
6767-c-DR-SOPS-project-start-sop.md Project Start SOP - Initialization checklist
6767-d-DR-TMPL-project-spec-pack.md Spec Pack Template - Project specification format
6767-e-DR-GUID-how-to-use-template.md Template Guide - How to use this template
6767-f-DR-STND-work-tracking-beads-taskids.md Beads Standard - Task tracking with Beads CLI
6767-g-DR-STND-beads-agentfs-complementary-systems.md Complementary Systems - How Beads + AgentFS work together
6767-h-OD-SOPS-gcp-firebase-setup-sop.md GCP/Firebase SOP - Cloud platform setup

πŸ“š Documentation Standards

Doc-Filing v4.0 Naming Convention

NNN-AA-CODE-descriptive-slug.md
  • NNN = 3-digit sequence (001, 026, 169) - never renumber
  • AA-CODE = Document type (see below)
  • descriptive-slug = kebab-case summary

Document Types

Code Type Purpose
AA-REPT After-Action Report Narrative summary of completed work
AA-AACR After-Action Completion Record Formal phase completion
AA-STAT Status/Analysis Current state, gap analysis
AA-PRD Product Requirements Feature/product specs
AA-ADR Architecture Decision Record Technical decisions
AA-TMPL Template Reusable document templates
DR-STND Standard Technical standards
DR-SOPS Standard Operating Procedure Process documentation
DR-GUID Guide How-to documentation
OD Overview/Operational High-level documentation

Full specification: 000-docs/6767-a-DR-STND-document-filing-system-standard-v4.md


πŸ”„ Syncing Template Updates

For Template Maintainers

When you update standards in this repository:

# 1. Update the file
vim 000-docs/6767-a-DR-STND-document-filing-system-standard-v4.md

# 2. Commit with clear message
git add -A
git commit -m "docs: update Doc-Filing standard - add new document type"
git push

# 3. Notify teams
# - Post in Slack/Teams
# - Email teams using template
# - Update CHANGELOG.md

For Project Teams

Pull latest standards into your project:

cd ~/my-project
~/000-projects/project-template/sync-from-template.sh

# Review changes
git diff

# Commit if acceptable
git add -A
git commit -m "chore: sync template standards (Doc-Filing v4.1)"
git push

πŸ› οΈ Customizing for Your Project

After creating a project from this template:

1. Update Project-Specific Files

# README.md
# - Replace with your project description
# - Update installation instructions
# - Add project-specific documentation

# AGENTS.md
# - Customize agent configuration for your project
# - Add project-specific workflows

# Keep these as-is (master versions):
# - CODE_OF_CONDUCT.md (symlink or copy, don't edit)
# - CONTRIBUTING.md (symlink or copy, don't edit)
# - SECURITY.md (symlink or copy, don't edit)

2. Remove Template-Specific Content

# Delete template guidance
rm 000-docs/6767-e-DR-GUID-how-to-use-template.md

# Keep standards and SOPs
# - 6767-a (Doc-Filing)
# - 6767-b (AAR Template)
# - 6767-c (Project Start SOP)
# - etc.

3. Initialize Beads Task Tracking

bd ready
bd create "Project setup" -p 1 --description "Initialize project from template"

πŸ“‹ Project Start Checklist

Follow this checklist when starting a new project from this template:

  • Create project from template (GitHub UI or CLI)
  • Clone repository locally
  • Update README.md with project details
  • Customize AGENTS.md for project workflows
  • Initialize Beads: bd ready
  • Follow 000-docs/6767-c-DR-SOPS-project-start-sop.md
  • Set up GitHub repository settings (branch protection, CI/CD)
  • Configure GCP/Firebase if needed (see 6767-h-OD-SOPS-gcp-firebase-setup-sop.md)
  • Create initial AAR documenting project setup

πŸ—οΈ Directory Structure

project-template/
β”œβ”€β”€ .beads/                     # Beads task tracking database
β”œβ”€β”€ 000-docs/                   # MASTER standards, templates, SOPs
β”‚   β”œβ”€β”€ 6767-a-DR-STND-document-filing-system-standard-v4.md
β”‚   β”œβ”€β”€ 6767-b-AA-TMPL-after-action-report-template.md
β”‚   β”œβ”€β”€ 6767-c-DR-SOPS-project-start-sop.md
β”‚   β”œβ”€β”€ 6767-d-DR-TMPL-project-spec-pack.md
β”‚   β”œβ”€β”€ 6767-e-DR-GUID-how-to-use-template.md
β”‚   β”œβ”€β”€ 6767-f-DR-STND-work-tracking-beads-taskids.md
β”‚   β”œβ”€β”€ 6767-g-DR-STND-beads-agentfs-complementary-systems.md
β”‚   β”œβ”€β”€ 6767-h-OD-SOPS-gcp-firebase-setup-sop.md
β”‚   └── [AARs documenting template evolution]
β”œβ”€β”€ AGENTS.md                   # Agent configuration template
β”œβ”€β”€ CLAUDE.md                   # Claude Code instructions (detailed)
β”œβ”€β”€ CODE_OF_CONDUCT.md          # MASTER - Contributor Covenant
β”œβ”€β”€ CONTRIBUTING.md             # MASTER - Contribution guidelines
β”œβ”€β”€ README.md                   # This file
β”œβ”€β”€ SECURITY.md                 # MASTER - Security policy
└── sync-from-template.sh       # Sync script for existing projects

πŸ” Security

This template contains NO secrets or API keys. All content is safe to make public.

For security issues in projects using this template, see the project's SECURITY.md.

For security issues in THIS template repo, contact: jeremy@intentsolutions.io


🀝 Contributing

This is an internal Intent Solutions template. Updates should be:

  1. Proposed via issue - Explain rationale for change
  2. Reviewed by maintainer - Ensure consistency across projects
  3. Documented in AAR - All changes get an AAR in 000-docs/
  4. Versioned properly - Major standards use semantic versioning

See CONTRIBUTING.md for detailed guidelines.


πŸ“œ License

Proprietary - Intent Solutions IO

This template and all standards are confidential and proprietary to Intent Solutions IO.


πŸ“ž Contact

Maintainer: Jeremy Longshore Email: jeremy@intentsolutions.io Organization: Intent Solutions IO


πŸ—‚οΈ Version History

Version Date Changes
4.0 2024-12 Doc-Filing v4.0, Beads standards, GCP SOPs
3.0 2024-10 AAR template v2, Project spec pack
2.0 2024-08 Initial community standards
1.0 2024-06 Initial template structure

Questions? Email jeremy@intentsolutions.io or open an issue.

About

Base project template for Intent Solutions repos. Standard directory structure, CI workflows, and documentation templates.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages