@@ -6,7 +6,7 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
66
77### Main Build Commands
88- ` ./gradlew assembleWordPressVanillaDebug ` - Build debug APK for WordPress app
9- - ` ./gradlew assembleJetpackVanillaDebug ` - Build debug APK for Jetpack app
9+ - ` ./gradlew assembleJetpackVanillaDebug ` - Build debug APK for Jetpack app
1010- ` ./gradlew installWordPressVanillaDebug ` - Install debug APK to connected device
1111- ` ./gradlew installJetpackVanillaDebug ` - Install debug APK for Jetpack to device
1212
@@ -38,7 +38,7 @@ This repository builds two apps from shared codebase:
3838├── WordPress/ # Main app module
3939├── libs/
4040│ ├── fluxc/ # Networking and data layer (FluxC architecture)
41- │ ├── login/ # Shared login functionality
41+ │ ├── login/ # Shared login functionality
4242│ ├── editor/ # Block editor integration
4343│ ├── image-editor/ # Image editing functionality
4444│ ├── analytics/ # Analytics and tracking
@@ -61,7 +61,7 @@ WordPress/src/main/java/org/wordpress/android/
6161├── ui/ # UI layer organized by feature
6262│ ├── posts/ # Post creation and management
6363│ ├── reader/ # Content discovery and reading
64- │ ├── stats/ # Site analytics and statistics
64+ │ ├── stats/ # Site analytics and statistics
6565│ ├── bloggingreminders/ # Posting reminders system
6666│ ├── comments/ # Comment management
6767│ ├── accounts/ # Authentication and signup
@@ -85,7 +85,7 @@ WordPress/src/main/java/org/wordpress/android/
8585### Code Quality Tools
8686- Android Code Style Guidelines with project-specific Checkstyle and Detekt rules
8787- ** Checkstyle** : Java code style enforcement (` config/checkstyle.xml ` )
88- - ** Detekt** : Kotlin code analysis (` config/detekt/detekt.yml ` )
88+ - ** Detekt** : Kotlin code analysis (` config/detekt/detekt.yml ` )
8989- ** Android Lint** : Built-in Android static analysis
9090- ** Line Length** : 120 characters max
9191- ** No FIXME** : Use TODO instead of FIXME in committed code
@@ -97,4 +97,71 @@ WordPress/src/main/java/org/wordpress/android/
9797- Remote build cache available for faster builds (requires setup)
9898- Fastlane used for release automation and testing
9999- Secrets managed via ` secrets.properties ` file (not in repo)
100- - Pre-commit hooks may modify files during commit
100+ - Pre-commit hooks may modify files during commit
101+
102+ ## Release Notes Compilation Process
103+
104+ ### Overview
105+ Process for compiling release notes for new versions, ensuring they meet Play Store character limits (under 500, preferably 350-400) and maintain the established playful tone.
106+
107+ ### Step-by-Step Process
108+
109+ #### 1. Study Previous Release Notes Style
110+ Use ` gh ` to fetch releases and analyze professional editorialization patterns:
111+ - ** Version 25.8** : Raw added in commits ` 8cd1b4cc268887b9e2de94fb19afc108b011f0da ` & ` 93591923dd9a9c144729952ad0dfbc9306f69894 ` , editorialized in ` 8a7fc316cf0acfc2b88b1090e3ca148f2145fa92 `
112+ - ** Version 25.9** : Raw added in ` b4a292cc9c9a30823bfdf8e770479a68362ed500 ` , editorialized in ` dad8fa582856758999c43384ccbe55f34b6d2e17 `
113+ - ** Version 26.0** : Raw added in ` a53234ea6b13adf18acac262ad985f94308191c6 ` & ` 63067fb7249cc860d44547bb0d1b8dee975dbe8e ` , editorialized in ` 02854d67c42146e611f0f0dff9feb0fd48dc7fd8 `
114+
115+ Commands: ` gh release view 25.8 ` , ` gh release view 25.9 ` , ` gh release view 26.0 ` (note: no 'v' prefix)
116+
117+ #### 2. Verify Release Branch and Get Last Release Hash
118+ - Verify current branch follows naming: ` release/x.y ` (where x.y = last_release + 0.1)
119+ - Get commit hash for last release: ` gh release view <last_version> --json tagName,targetCommitish `
120+ - Confirm current branch is properly ahead of last release tag
121+
122+ #### 3. Identify Changes Since Last Release
123+ Compare current release branch against last release hash:
124+ ``` bash
125+ git log < last_release_hash> ..HEAD --oneline --no-merges
126+ ```
127+ Focus on user-facing changes from squash commit messages. ** Important** : When commit messages are unclear or technical, always investigate further:
128+ - Use ` gh pr view <PR_number> ` to read PR titles and descriptions
129+ - Look for keywords indicating user-facing changes: "feat:", new functionality, UI changes, user experience
130+ - Be especially careful with feature rollouts that may have technical-sounding commit messages but represent new user functionality
131+ - When in doubt, investigate the PR rather than excluding potentially important features
132+
133+ #### 4. Compile Raw Release Notes
134+ Create factual summary including:
135+ - Only user-facing changes (exclude CI, refactoring, technical debt)
136+ - Prioritize: New features → Improvements → Performance enhancements
137+ - Use positive language (avoid "bug fix", prefer "improved", "enhanced", "resolved")
138+ - Include rough character counts to gauge condensation needed
139+ - Mark changes as WordPress-specific, Jetpack-specific, or both
140+
141+ #### 5. User Confirmation
142+ Present raw notes to user for:
143+ - Accuracy verification
144+ - WordPress vs Jetpack feature classification
145+ - Any missing or incorrect changes
146+ - Approval to proceed with editorialization
147+
148+ #### 6. Editorialization
149+ Transform raw notes using established playful style:
150+ - Keep under 350 characters (accounting for translation expansion)
151+ - Use engaging, user-friendly language
152+ - Reference previous release note styles from step 1
153+ - Create separate versions for WordPress and Jetpack apps
154+ - Focus on user benefits and experience improvements
155+
156+ #### 7. Update Release Notes Files
157+ Once user confirms the editorialized release notes, ** replace** the contents of the following files (discard any existing content):
158+ - ** WordPress release notes** : ` WordPress/metadata/release_notes.txt `
159+ - ** Jetpack release notes** : ` WordPress/jetpack_metadata/release_notes.txt `
160+
161+ Document any process refinements discovered during execution.
162+
163+ ### Content Guidelines
164+ - ** Include** : New features, UI improvements, performance enhancements, user experience changes
165+ - ** Exclude** : CI changes, code refactoring, dependency updates, internal technical changes
166+ - ** Language** : Positive sentiment, avoid "fix" terminology, focus on improvements and enhancements
167+ - ** Priority Order** : New features → Improvements → Performance → Other user-facing changes
0 commit comments