docs: enhance CLAUDE.md with GitHub workflow guidance #7497
+137
−0
Conversation
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
|
Moved to ready to review but will keep it open, we can add to it for a while maybe. |
stasadev
reviewed
Aug 1, 2025
Comment on lines
+174
to
+199
| Format: `<type>[optional !]: <description>[, fixes #<issue>]` | ||
|
|
||
| Types: `build`, `ci`, `docs`, `feat`, `fix`, `refactor`, `test` | ||
|
|
||
| - Use imperative, present tense ("change" not "changed") | ||
| - Don't capitalize first letter | ||
| - No period at end | ||
| - Add `, fixes #<issue>` if applicable | ||
| - Breaking changes require `!` after type |
There was a problem hiding this comment.
I think we should allow <type>[optional scope] instead of <type>[optional !] in the same way how this is defined in https://www.conventionalcommits.org/en/v1.0.0/
Sometimes I struggle to give short commit message, but with scope it's much easier:
before: feat: update Pantheon provider to use environment variables
after feat(pantheon): use environment variables
Changing this logic requires an update for:
.github/workflows/pr-check.yml- https://ddev.readthedocs.io/en/stable/developers/building-contributing/#pull-request-title-guidelines
There was a problem hiding this comment.
And I would add the chore type to the list.
There was a problem hiding this comment.
I'm all for that, although it's more related to our PR checker than this, true? I'd be OK with changing it in the PR checker in this PR and updating this though.
There was a problem hiding this comment.
Yes, whatever you choose, it's okay to edit this PR or add a new one for this.
## The Issue - No specific issue, but documentation improvements needed based on lessons learned CLAUDE.md lacked comprehensive GitHub workflow guidance for Claude Code sessions, particularly around: - Branch creation best practices - GitHub issue template usage with ddev debug test output - PR template requirements and commit message integration - Testing requirements before commits - Pre-commit workflow combining testing and static analysis ## How This PR Solves The Issue Enhanced CLAUDE.md with detailed sections covering: 1. **Branch Naming & Creation**: Added efficient strategy using `git fetch upstream && git checkout -b <branch> upstream/main --no-track` 2. **GitHub Issue Templates**: Complete guidance on using issue template structure with proper `ddev debug test` output inclusion in collapsible sections 3. **PR Template Integration**: Clear explanation that commit messages should include full PR template content for pre-population on GitHub 4. **Testing Requirements**: Added comprehensive testing guidance with `make test`, `make testpkg`, `make testcmd` options and reference to official testing docs 5. **Pre-Commit Workflow**: Complete checklist including both testing and static analysis requirements ## Manual Testing Instructions 1. Review CLAUDE.md sections for completeness and accuracy 2. Verify markdown formatting passes `make staticrequired` 3. Confirm all referenced documentation links are valid 4. Test workflow guidance matches current DDEV development practices ## Automated Testing Overview Changes are documentation-only and pass: - markdownlint validation - mkdocs build verification - No functional code changes requiring additional tests ## Release/Deployment Notes This is documentation enhancement only with no deployment impact. Future Claude Code sessions will have improved workflow guidance for DDEV development. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
rfay
force-pushed
the
20250731_rfay_improve_claude_docs
branch
from
43aa8e6 to
a71b8f2
Compare
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.
The Issue
CLAUDE.md lacked comprehensive GitHub workflow guidance for Claude Code sessions, particularly around:
How This PR Solves The Issue
Enhanced CLAUDE.md with detailed sections covering:
git fetch upstream && git checkout -b <branch> upstream/main --no-trackddev debug testoutput inclusion in collapsible sectionsmake test,make testpkg,make testcmdoptions and reference to official testing docsManual Testing Instructions
make staticrequiredAutomated Testing Overview
Changes are documentation-only and pass:
Release/Deployment Notes
This is documentation enhancement only with no deployment impact. Future Claude Code sessions will have improved workflow guidance for DDEV development.
🤖 Generated with Claude Code