Skip to content

Add comprehensive LLM instruction file for educational project#9

Merged
jeffabailey merged 1 commit intomainfrom
claude/add-llm-instruction-file-011CUTooDFtDiS8HFF3UjWA6
Oct 25, 2025
Merged

Add comprehensive LLM instruction file for educational project#9
jeffabailey merged 1 commit intomainfrom
claude/add-llm-instruction-file-011CUTooDFtDiS8HFF3UjWA6

Conversation

@jeffabailey
Copy link
Owner

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

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update
  • Test coverage improvement
  • Code refactoring

Testing

Tests Added/Modified

  • Added unit tests for new functionality
  • Updated existing tests to reflect changes
  • All tests pass locally
  • Test coverage meets or exceeds 80% threshold (for JavaScript)

Test Commands Run

# Add the commands you ran to test your changes
# Example:
# cd programming/python && pytest --cov

Coverage

  • Coverage reports have been reviewed
  • No decrease in overall coverage
  • New code has appropriate test coverage

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published

Related Issues

Closes #

Additional Notes

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>
@jeffabailey jeffabailey merged commit 640cc82 into main Oct 25, 2025
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants