docs: add comprehensive coding specification for AI tools #160
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add CODING_SPEC.md which provides detailed guidance for AI tools and developers contributing to the projen-pipelines project. The specification covers: - Architecture and design patterns (multi-engine abstraction, template method, composite, factory) - Code style and ESLint conventions (indentation, quotes, semicolons, line length) - TypeScript conventions (readonly properties, type safety, nullish coalescing) - File organization and directory structure - Testing practices (Jest, snapshot testing, coverage requirements) - Documentation standards (JSDoc comments, @default tags) - Common patterns and idioms used throughout the codebase - Contribution guidelines and code review checklist - Advanced topics (adding new CI/CD engines, creating custom steps) This document serves as a comprehensive reference for maintaining code consistency and quality across the project.
Removed sections on Enums vs. String Unions and Generic Interfaces from the coding specifications.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add CODING_SPEC.md which provides detailed guidance for AI tools and developers
contributing to the projen-pipelines project. The specification covers:
This document serves as a comprehensive reference for maintaining code consistency
and quality across the project.