Add comprehensive LLM instruction file for educational project#9
Merged
jeffabailey merged 1 commit intomainfrom Oct 25, 2025
Merged
Conversation
This .clinerules file provides strict guidelines for Claude and other AI assistants working on this educational repository. Key requirements: 1. Beginner-First Code: All code must be understandable by programming beginners with clear variable names, comprehensive comments, and simple logic flow 2. Near-100% Test Coverage: Every function must be thoroughly tested with readable tests that serve as learning examples 3. Trivial to Run: Clear step-by-step instructions assuming minimal technical knowledge, with minimal dependencies and complete documentation 4. Self-Contained Modules: Each learning folder can be cloned independently, uses only one programming language, and includes all necessary resources 5. Automated Quality Checks: Every module must have GitHub Actions for tests, coverage reporting, and quality verification The file includes detailed standards, examples, prohibited practices, and a comprehensive checklist to ensure all learning materials maintain high educational quality and accessibility. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
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
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.
This .clinerules file provides strict guidelines for Claude and other AI assistants working on this educational repository. Key requirements:
Beginner-First Code: All code must be understandable by programming beginners with clear variable names, comprehensive comments, and simple logic flow
Near-100% Test Coverage: Every function must be thoroughly tested with readable tests that serve as learning examples
Trivial to Run: Clear step-by-step instructions assuming minimal technical knowledge, with minimal dependencies and complete documentation
Self-Contained Modules: Each learning folder can be cloned independently, uses only one programming language, and includes all necessary resources
Automated Quality Checks: Every module must have GitHub Actions for tests, coverage reporting, and quality verification
The file includes detailed standards, examples, prohibited practices, and a comprehensive checklist to ensure all learning materials maintain high educational quality and accessibility.
🤖 Generated with Claude Code
Description
Type of Change
Testing
Tests Added/Modified
Test Commands Run
Coverage
Checklist
Related Issues
Closes #
Additional Notes