DO-1867: refresh repo docs and adopt org-shared community files#1674
Merged
Conversation
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description of the proposed changes
Refreshes the repository's developer-facing documentation:
CLAUDE.md— corrects inaccurate guidance (the install command, the package layout, thedist/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 foraws-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 inaligent/.github. GitHub will fall back to those automatically.Notes to reviewers
ℹ️ 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