feat: improve template workflow and README handling#6
Merged
Conversation
- 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
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.
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
2. Improved Template Workflow
docs/how_to_use_this_template.md(better naming).cursor/templates/project_readme.md3. Benefits
Files Changed
.cursor/rules/workflow.mdc- Streamlined workflow rulesREADME.md- Updated quick start and usage instructions.cursor/templates/project_readme.md- New template file for project READMEsTesting