feat: Improved .tmporc File + CLAUDE.md#9
Merged
Conversation
Introduces CreateWithTemplate to generate .tmporc files with all config fields and helpful comments, improving user experience. Updates init command to use the new function. Adds a configTemplate constant and documentation to ensure future fields are reflected in the template.
Introduced CLAUDE.md to provide guidance for Claude Code on repository structure and development practices. Commented out the push trigger in the test GitHub Actions workflow, so tests now only run on pull requests to the main branch.
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
1 participant
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 pull request introduces improvements to project configuration handling and developer documentation, along with a minor update to the CI workflow. The most significant change is the addition of a template-based approach for generating
.tmporcconfiguration files, ensuring all available configuration options are visible and well-documented for users. Additionally, a comprehensiveCLAUDE.mdfile has been added to guide contributors and AI tools.Configuration improvements:
CreateWithTemplatefunction ininternal/config/config.gothat generates.tmporcfiles using a template with all config fields and helpful comments, improving the user experience for project setup. (internal/config/config.go, internal/config/config.goR98-R115)initcommand to useCreateWithTemplateinstead of the previousCreatefunction, so new.tmporcfiles are always generated with the template. (cmd/init.go, cmd/init.goL51-R51)configTemplateconstant and added clear documentation/comments emphasizing that any new fields in theConfigstruct must also be added to the template, ensuring maintainability. (internal/config/config.go, internal/config/config.goR17-R45)Documentation:
CLAUDE.mdfile providing project overview, architecture, build/test instructions, and important notes for contributors and AI assistants.CI workflow:
pushtrigger in.github/workflows/test.yml, so tests now only run on pull requests to themainbranch.