Skip to content

Comments

feat: improve template workflow and README handling#6

Merged
jpke merged 1 commit intomainfrom
feature/template-workflow-improvements
Jul 4, 2025
Merged

feat: improve template workflow and README handling#6
jpke merged 1 commit intomainfrom
feature/template-workflow-improvements

Conversation

@jpke
Copy link
Owner

@jpke jpke commented Jul 4, 2025

Summary

This PR improves the template workflow and README handling to better support the intended use case of this repository as a GitHub template.

Changes Made

1. Clarified Usage Patterns

  • Updated README to prioritize GitHub template usage over cloning
  • Distinguished between "set up template" vs "initialize repo" workflows
  • Added clear notes about when git initialization is needed

2. Improved Template Workflow

  • Move original README to docs/how_to_use_this_template.md (better naming)
  • Abstract README template to .cursor/templates/project_readme.md
  • Minimize workflow rules by extracting template content
  • Better organization and maintainability

3. Benefits

  • ✅ Cleaner, more focused workflow rules
  • ✅ Template content separated from workflow logic
  • ✅ Easier maintenance and updates
  • ✅ Better user experience for GitHub template usage
  • ✅ Preserved original documentation for reference

Files Changed

  • .cursor/rules/workflow.mdc - Streamlined workflow rules
  • README.md - Updated quick start and usage instructions
  • .cursor/templates/project_readme.md - New template file for project READMEs

Testing

  • Pre-commit hooks pass
  • Template structure is logical and maintainable
  • Documentation is clear and accurate

- Clarify GitHub template vs clone workflows in README and rules
- Abstract README template to .cursor/templates/project_readme.md
- Rename preserved README to how_to_use_this_template.md
- Minimize workflow rules by extracting template content
- Better organization and maintainability
@jpke jpke merged commit 222af4f into main Jul 4, 2025
7 checks passed
@jpke jpke deleted the feature/template-workflow-improvements branch July 4, 2025 20:59
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.

1 participant