1
0
mirror of https://github.com/chylex/IntelliJ-IdeaVim.git synced 2025-10-09 04:26:57 +02:00
Commit Graph

14 Commits

Author SHA1 Message Date
Alex Plate
1c6e9354fb Add instruction to examine commit content, not just messages
- Emphasize using git show to see full commit content
- Note that test files contain good examples for changelog
- Encourage looking at actual code changes for better understanding
- Help find specific command examples from tests
2025-08-30 11:57:20 +03:00
Alex Plate
2bc5daf2bf Add instruction to read PR comments for changelog guidance
- Emphasize reading PR comments from previous changelog updates
- Add gh command to view PR comments
- Note that review feedback may indicate what to avoid
- Help ensure special instructions from PR discussions are followed
2025-08-30 11:56:42 +03:00
Alex Plate
8e7beea33e Add note about reading only top portion of CHANGES.md
- Clarify that CHANGES.md is a large file
- Instruct to focus on [To Be Released] section and recent versions
- Avoid reading the entire file unnecessarily
2025-08-30 11:55:21 +03:00
Alex Plate
8b9e904623 Add dedicated section for updating changeNotes in build.gradle.kts
- Create separate section with detailed instructions for changeNotes
- Clarify that content should match CHANGES.md exactly (no summarizing)
- Provide HTML formatting guidelines and examples
- Emphasize not to create shorter or condensed versions
- Include example showing Markdown to HTML conversion
2025-08-30 11:19:59 +03:00
Alex Plate
ed14efc55c Add instruction to use PR titles as-is in changelog
- Specify that PR descriptions should be taken directly from PR titles
- Don't regenerate or rewrite PR descriptions
- Maintain author's original wording for PR entries
2025-08-30 11:11:40 +03:00
Alex Plate
deae5fea8e Add special rules for Merged PRs section in changelog
- Clarify that PRs have different inclusion criteria than Features/Fixes
- Note that internal changes and refactoring PRs should be included
- Emphasize acknowledging community contributions regardless of visibility
- Make clear that "user-visible only" rule doesn't apply to PRs section
2025-08-30 11:10:27 +03:00
Alex Plate
f5c5bd82ba Add another example of unclear changelog entry to avoid
- Add "Fixed inlay offset calculations" as bad example
- Show better alternative with specific user-visible case
- Reinforce that technical internal fixes should either have clear user impact or be omitted
2025-08-30 11:09:02 +03:00
Alex Plate
3b88a57478 Add guidance for clear, specific changelog entries
- Include bad example: "Fixed count validation in text objects" (too vague)
- Show better alternative: specific command that was fixed
- Emphasize: if unable to determine specific case, omit entry rather than be unclear
- Help ensure all changelog entries are meaningful to users
2025-08-30 11:07:13 +03:00
Alex Plate
00d08c3840 Add instructions to avoid duplication in changelog subsections
- Clarify that each change should appear in only ONE subsection
- Add note that features can also use YouTrack link format
- Emphasize no duplication between Features, Fixes, and other categories
- Update both Format Notes and Writing Style sections for clarity
2025-08-30 11:04:57 +03:00
Alex Plate
a5dd8cf8b1 Update PR title format for changelog updates
- Change PR title format to "Update changelog: <super short summary>"
- Add example showing how to summarize key changes in title
- Update both GitHub workflow and changelog instructions for consistency
2025-08-30 10:55:54 +03:00
Alex Plate
22b17e8cc5 Add instruction to include helpful documentation links in changelog
- Guide to search for and include official documentation links
- Add links to JetBrains features and Vim commands when relevant
- Include examples showing linked IntelliJ features (Next Edit Suggestion, multiple cursors)
- Help users find more information about mentioned features
2025-08-30 10:54:16 +03:00
Alex Plate
070b608687 Add guidance for including command examples in changelog
- Add instruction to include examples of commands/operations in changelog entries
- Update example entries to demonstrate including specific commands
- Show how to describe what now works for both fixes and features
- Help users understand how to use new features or what was fixed
2025-08-30 10:51:34 +03:00
Alex Plate
a72db2b5af Add user-focus emphasis to changelog instructions
- Clarify that internal code changes should not be logged
- Emphasize that changelog is for users, not developers
- Strengthen user-focused writing style guidelines
- Exclude refactoring, code cleanup, and internal architecture changes
2025-08-30 10:49:20 +03:00
Alex Plate
9f58c73d92 Refactor documentation structure and extract changelog instructions
- Simplified CLAUDE.md to avoid redundancy with other docs
- Created .claude/changelog-instructions.md with detailed changelog maintenance guide
- Updated GitHub Action to reference the new changelog instructions doc
- Added instructions for updating changeNotes in build.gradle.kts
- Added notes about excluding API module changes (experimental status)
- Added step to check previous changelog PRs for special instructions
2025-08-30 10:42:01 +03:00