|
| 1 | +# Project Context Documentation |
| 2 | + |
| 3 | +## Overview |
| 4 | +This document provides context for the codebase-context-spec project, which aims to define and implement a specification for capturing and utilizing codebase context in software development. |
| 5 | + |
| 6 | +## Project Structure |
| 7 | +- `.context.md`: Contains project-wide context information |
| 8 | +- `README.md`: Project introduction and general information |
| 9 | +- `CODEBASE-CONTEXT.md`: Detailed specification for codebase context |
| 10 | +- `img/`: Directory for project images |
| 11 | +- `linters/`: Directory containing linter implementations |
| 12 | + - `python/`: Python linter implementation |
| 13 | + - `typescript/`: TypeScript linter implementation |
| 14 | + |
| 15 | +## Key Components |
| 16 | +1. **Context Specification**: Defined in `CODEBASE-CONTEXT.md`, this outlines the structure and format for capturing codebase context. |
| 17 | + |
| 18 | +2. **Linter Implementations**: |
| 19 | + - Python linter in `linters/python/` |
| 20 | + - TypeScript linter in `linters/typescript/` |
| 21 | + |
| 22 | +3. **Visual Representation**: `img/codebase-context.png` provides a visual overview of the codebase context concept. |
| 23 | + |
| 24 | +## Development Guidelines |
| 25 | +- Follow the specification outlined in `CODEBASE-CONTEXT.md` when implementing context-aware features. |
| 26 | +- Ensure all linter implementations adhere to the same core principles while respecting language-specific best practices. |
| 27 | +- Keep `.context.md` files updated in each directory to maintain accurate context information. |
| 28 | + |
| 29 | +## Tools and Technologies |
| 30 | +- TypeScript for the TypeScript linter implementation |
| 31 | +- Python for the Python linter implementation |
| 32 | +- Markdown for documentation |
| 33 | + |
| 34 | +## Future Directions |
| 35 | +- Implement additional language-specific linters |
| 36 | +- Develop integration plugins for popular IDEs |
| 37 | +- Create a standardized API for context-aware tool interactions |
| 38 | + |
| 39 | +## Contributing |
| 40 | +Refer to the project's contribution guidelines (if available) for information on how to contribute to this project. |
| 41 | + |
| 42 | +--- |
| 43 | + |
| 44 | +This context documentation provides a high-level overview of the project. For more detailed information, please refer to specific `.context.md` files in each directory and the `CODEBASE-CONTEXT.md` specification. |
0 commit comments