Skip to content

chore: scrub private-project references from examples and docs - #35

Merged
olehsvyrydov merged 4 commits into
mainfrom
chore/scrub-private-project-refs
Jun 6, 2026
Merged

chore: scrub private-project references from examples and docs#35
olehsvyrydov merged 4 commits into
mainfrom
chore/scrub-private-project-refs

Conversation

@olehsvyrydov

Copy link
Copy Markdown
Owner

Summary

Replaces personal/private project codenames in example and reference content with vendor-neutral placeholders, so the framework ships nothing project-specific.

Changes

Area Change
Jira-key examples Lemmejob / LJExample Project / PROJ (TEAM_WORKFLOW.md, README.md, reviewer process-and-style.md)
HMRC + JavaFX references uk.selfemploy.* packages/paths + Self-Employment UK / UK Self-Employment Manager strings → com.example.taxapp / Example Tax App / Example Tax Ltd
docs/bumbl/docs/persistent-memory/ Stripped the project name + brand metaphor; reframed as a name-free, not-committed future-vision concept; added Onyx / Obsidian / mem0 / self-built as build-vs-adopt options

Deliberately kept

Generic UK-tax / HMRC domain vocabulary is left intact, as it is not a private project: selfEmployment identifiers, the /self-employments API path, SA103, Class 4 NI, and the uk-self-employment skill.

Two illustrative spots that use generic SE- / "self-employment app" placeholders as deliberate bad examples / test fixtures (not a real codename) were left unchanged:

  • claude/skills/management/scrum-master/references/knowledge-and-retro.md — a "WRONG example" of project-specific clutter
  • claude/rag/kai/tests/test_quality.py — a universality-validator test fixture

Notes

  • No CHANGELOG entry: non-functional example/doc cleanup on an already-released version (5.0.0).
  • No documentation cross-references needed updating — nothing linked to the old docs/bumbl/ folder.

Replace personal/private project codenames in example and reference
content with vendor-neutral placeholders so the framework ships nothing
project-specific.

- Jira-key examples: Lemmejob / LJ -> Example Project / PROJ
  (TEAM_WORKFLOW.md, README.md, reviewer process-and-style.md)
- HMRC + JavaFX references: uk.selfemploy.* packages, paths, and the
  "Self-Employment UK" / "UK Self-Employment Manager" strings ->
  com.example.taxapp / Example Tax App / Example Tax Ltd
- docs/bumbl -> docs/persistent-memory: strip the project name and brand
  metaphor, reframe as a name-free, not-committed future-vision concept,
  and add Onyx / Obsidian / mem0 / self-built as build-vs-adopt options

Generic UK-tax/HMRC domain terms (selfEmployment, /self-employments API
path, SA103, the uk-self-employment skill) are kept as legitimate domain
vocabulary.
Copilot AI review requested due to automatic review settings June 6, 2026 16:51

Copilot AI 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.

Pull request overview

This PR scrubs personal/private project codenames and branding from example/docs content, replacing them with vendor-neutral placeholders and reframing the “persistent memory assistant” docs as an aspirational, not-committed concept.

Changes:

  • Replaced private Jira project-key examples with PROJ / “Example Project”.
  • Renamed the former docs/bumbl/ concept docs to docs/persistent-memory/ and clarified the work is aspirational (build vs adopt, no committed roadmap).
  • Replaced self-employment app example package/vendor strings with com.example.taxapp, “Example Tax App”, and “Example Tax Ltd”.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
README.md Updates Jira/Git example ticket keys to vendor-neutral placeholders.
docs/persistent-memory/vision.md Renames and reframes the vision doc as a non-committed concept.
docs/persistent-memory/README.md Adds an index/landing README for the concept docs.
docs/persistent-memory/market-research.md Renames and expands market research; adds adopt-before-build options.
docs/persistent-memory/architecture-decision.md Reframes ADR as “suggested architecture” for a hypothetical build.
docs/bumbl/README.md Removes the old branded concept README under docs/bumbl/.
claude/TEAM_WORKFLOW.md Updates Jira key/project examples to “Example Project” / PROJ.
claude/skills/quality/review/reviewer/references/process-and-style.md Updates TODO ticket-key example to PROJ-123.
claude/skills/development/frontend/react/frontend-developer/references/javafx-desktop/references/javafx-expertise.md Scrubs JavaFX app example package/vendor strings to com.example.taxapp and placeholder branding.
claude/skills/development/backend/java/backend-developer/references/hmrc-api/references/api-oauth-fraud.md Scrubs HMRC fraud-prevention header example vendor/product strings and local storage path.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

The project is owner-maintained under the repo's MIT license; the
commercial-vs-OSS, branding, and "if pursued" uncertainty no longer
applies.

- Remove the "Open Questions" section from vision.md
- Reframe README/vision from "aspirational concept, not committed" to a
  planned, not-yet-implemented tool
- Soften architecture status from "not committed" to a suggested stack;
  drop "(undecided)" from the Phase 4 heading

Build-vs-adopt guidance (Onyx / Obsidian / mem0) is retained.
…rAgent

Copilot review on PR #35: the user-agent string still hard-coded the
old identifier. Aligned it with the Example-Tax-App placeholder.
@olehsvyrydov

Copy link
Copy Markdown
Owner Author

Copilot review — addressed ✅

Thanks for the review. Round summary:

  • 1 inline comment (api-oauth-fraud.md, buildUserAgent() still hard-coded UK-Self-Employment-Manager) → fixed in 21cc319, now Example-Tax-App/.... Replied inline.
  • No other actionable comments — the rest of the review was the overview + per-file summary (10/10 files reviewed).

One note: the review overview describes the persistent-memory docs as an "aspirational, not-committed concept." That reflected the first commit; a later commit (cc004be) intentionally removed the "Open Questions / not committed" hedging, since this is an owner-maintained project under the repo MIT license. So that framing is current-by-design, not an oversight.

Ready for re-review.

Copilot AI 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.

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Comment thread claude/TEAM_WORKFLOW.md Outdated
…older

Copilot re-review on PR #35: the multi-project table showed EXAMPLE (PROJ)
while the surrounding text and Confluence space use "Example Project".
Aligned the project name and re-padded the table column.

Copilot AI 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.

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated no new comments.

@olehsvyrydov
olehsvyrydov merged commit 4363e02 into main Jun 6, 2026
1 check passed
@olehsvyrydov
olehsvyrydov deleted the chore/scrub-private-project-refs branch June 6, 2026 17:23
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