Skip to content

DO-1867: refresh repo docs and adopt org-shared community files#1674

Merged
TheOrangePuff merged 4 commits into
mainfrom
feature/DO-1867_update_claude_md_docs
May 6, 2026
Merged

DO-1867: refresh repo docs and adopt org-shared community files#1674
TheOrangePuff merged 4 commits into
mainfrom
feature/DO-1867_update_claude_md_docs

Conversation

@TheOrangePuff
Copy link
Copy Markdown
Member

Description of the proposed changes

Refreshes the repository's developer-facing documentation:

  • CLAUDE.md — corrects inaccurate guidance (the install command, the package layout, the dist/ path, etc.) and brings it in line with how the repo actually works (Yarn 4 / Corepack workspaces, nx affected:* mirroring CI, Changesets release flow with the team's "confirm with the user before writing a changeset" rule, peer-dep contract for aws-cdk-lib/constructs, ESLint module-boundary allowlist).
  • README.md — adds an "Adding a new package" section under Contributing covering the package skeleton, the constructs-table update, and the changeset for the initial release. Includes a > [!IMPORTANT] callout that the first publish must be done manually because our release workflow uses npm OIDC trusted publishing, which can only push new versions to packages that already exist on npm — it cannot create the package itself.
  • CONTRIBUTING.md, CODE_OF_CONDUCT.md, .github/pull_request_template.md — removed in favour of the org-shared equivalents in aligent/.github. GitHub will fall back to those automatically.

Notes to reviewers

  • Three commits, each scoped to one logical change, so the diff is easy to read commit-by-commit.
  • No code or workflow changes — docs/community-files only.

ℹ️ When you've finished leaving feedback, please add a final comment to the PR tagging the author, letting them know that you have finished leaving feedback

- Delete CONTRIBUTING.md, CODE_OF_CONDUCT.md, and .github/pull_request_template.md
- GitHub will now fall back to the shared files in aligent/.github
@TheOrangePuff TheOrangePuff requested a review from a team as a code owner May 6, 2026 01:04
Copy link
Copy Markdown
Contributor

@aaronmedina-dev aaronmedina-dev left a comment

Choose a reason for hiding this comment

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

LGTM

@TheOrangePuff TheOrangePuff merged commit 28e5488 into main May 6, 2026
8 checks passed
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