Skip to content

maxfelker/code-guidance

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Code Guidance

A collection of markdown documentation files providing guidance to humans and AI agents on programming approaches, patterns, and best practices.

Purpose

This repository serves as a knowledge base documenting proven approaches and patterns used across various projects. Each file focuses on a specific technology, framework, or architectural pattern.

Contents

  • React - React application architecture and patterns
  • JavaScript - JavaScript fundamentals and patterns
  • Docker - Docker containerization for frontend applications

Usage

These documents are designed to be:

  • Reference material for developers working on projects
  • Context for AI agents to understand preferred patterns and approaches
  • Living documentation that evolves with our projects

Contributing

When documenting a new approach:

  1. Create a new markdown file for the technology/pattern
  2. Include real examples from existing projects
  3. Focus on practical patterns rather than theoretical concepts
  4. Update this README to link to the new document

About

A collection of my curated guidance for general engineering and specific code bases that I work frequently in. For humans and agents alike

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors