Skip to content

Add README files for all JavaScript packages#9853

Merged
aduth merged 1 commit intomainfrom
aduth-workspace-package-readmes
Jan 4, 2024
Merged

Add README files for all JavaScript packages#9853
aduth merged 1 commit intomainfrom
aduth-workspace-package-readmes

Conversation

@aduth
Copy link
Contributor

@aduth aduth commented Jan 4, 2024

🛠 Summary of changes

Adds README files for all JavaScript workspace packages currently missing one.

Why?

  • It's expected that each package should have a README, enforced by make validate_workspaces,
    • Helps onboarding for new developers to understand the purpose of a package and minimal usage instructions
  • Avoid temptation for developers to add new exceptions to the existing workspace validation enforcement
    • Without pointing fingers, this has happened on at least one occasion

📜 Testing Plan

Read through included documentation and ensure that it's sensible as a minimal documentation for each package.

changelog: Internal, Documentation, Ensure all JavaScript workspace packages have documentation
@aduth aduth merged commit 2b5c62d into main Jan 4, 2024
@aduth aduth deleted the aduth-workspace-package-readmes branch January 4, 2024 18:16
@amirbey amirbey mentioned this pull request Jan 9, 2024
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