Skip to content

docs: share store release-note checks - #294

Closed
piotr-iohk wants to merge 1 commit into
mainfrom
docs/store-notes-guidelines
Closed

piotr-iohk wants to merge 1 commit into
mainfrom
docs/store-notes-guidelines

Conversation

@piotr-iohk

@piotr-iohk piotr-iohk commented Nov 5, 2026 •

Copy link
Copy Markdown
Collaborator

Companion: synonymdev/bitkit-ios#1224, synonymdev/bitkit-android#1791

Release-note generation can carry another mobile platform's name into App Store metadata, and translated or reused copies can retain the same problem. Add one shared method for drafting and checking store notes before generation and before an authorized submission/resubmission.

Description

  • Document Apple's platform-reference restriction separately from Google's accuracy/relevance requirements, with official source links.
  • Require checks for every translation/configured locale, synchronization of approved local/Drive/GitHub/store text, and final saved-field readback.
  • Keep content generation separate from store approval and preserve human edits, changelogs and optional-document fallbacks.
  • Link the guide from the repository instructions and README; native command consumers will depend on this PR merging first.

QA Notes

Setup

N/A — documentation only.

Journeys

N/A — no app/runtime behavior changes.

Manual Tests

N/A — no device testing required.

Automated Checks

  • ran git diff --check.
  • ran Markdown fence and local-reference checks across the shared guide and both consumer changes.

Evidence

Official Apple/Google policy pages checked on 2026-11-05. Independent review of the three-repository candidate found no actionable findings.

Gaps

The consumer PRs must merge after this guide. No store submission, app build or runtime test was performed as part of this documentation change.

Models used

  • Planning/scoping: gpt-6.1-sol (reasoning: high)
  • Implementation: gpt-6.1-sol (reasoning: high)
  • Review: gpt-6.1-sol (reasoning: high)
  • Review rounds: 1

@talosmachina talosmachina left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No findings. Adds the shared store release-note method (docs/store-release-notes.md) and links it from AGENTS.md and the README, for the native /release commands to load. Reviewed 8c195a3, light tier (docs only, nothing to build).

What I checked, and 3 candidates I ruled out

Read in full: docs/store-release-notes.md, the AGENTS.md and README.md hunks, and both consumers (synonymdev/bitkit-android#1791, synonymdev/bitkit-ios#1224)
CI: no checks run on this branch

Ruled out

  • Language list drifting from the consumers: the guide's English, French, Spanish, Portuguese and German match the five headings both /release commands write to .ai/release-notes-{version}.md.
  • Check record committed by accident: .ai/store-notes-check-{version}.md sits under .ai/, which both app repos' .gitignore already excludes.
  • Policy statements: guideline 2.3.10 (other mobile platforms in metadata only with approved interactive functionality) and Play's 500-character release-note limit match the linked official pages.

Merge confidence: 5/5, docs only, and the references and language mapping check out against both consumers.

Reviewer model: claude-opus-5-5
Reasoning effort: Not exposed (the run metadata available to this reviewer does not report it)

@piotr-iohk

Copy link
Copy Markdown
Collaborator Author

Replaced by synonymdev/bitkit#4, which keeps shared store release-note guidance in the Bitkit umbrella repository. The native consumers synonymdev/bitkit-ios#1224 and synonymdev/bitkit-android#1791 now depend on that PR. The shared release QA method and test archives remain in this E2E repository.

@piotr-iohk piotr-iohk closed this Nov 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants