Add package generator
[FX-NNNN]
Description
Updates outdated tutorials on package generation and adds a new Hygen generator to insert packages.
How to test
- Temploy
- Checkout the branch
- Run
yarn generate:packageand follow the instructions:- BASE packages should be automatically created in
packages/base - Normal packages will be added to
packages - After generation is finished, you should be instantly able to import new code from any other module (you can try the autocomplete)
- BASE packages should be automatically created in
- Look for any of the required files that are missing in the generated package
Development checks
- [n/a] Add changeset according to guidelines (if needed)
- [x] Read CONTRIBUTING.md and Component API principles
- [n/a] Make sure that additions and changes on the design follow Toptal's BASE design, and it's been already discussed with designers at #-base-core
- [n/a] Annotate all
propsin component with documentation - [n/a] Create
examplesfor component - [x] Ensure that deployed demo has expected results and good examples
- [n/a] Ensure the changed/created components have not caused accessibility issues. How to use accessibility plugin in storybook.
- [x] Self reviewed
- [n/a] Covered with tests (visual tests included)
All development checks should be done and set checked to pass the GitHub Bot: TODOLess action
PR commands
List of available commands:
-
@toptal-bot run package:alpha-release- Release alpha version -
@toptal-anvil ping reviewers- Ping FX team for review
PR Review Guidelines
When to approve? ✅
You are OK with merging this PR and
- You have no extra requests.
- You have optional requests.
- Add
nit:to your comment. (ex.nit: I'd rename this variable from makeCircle to getCircle)
- Add
When to request changes? ❌
You are not OK with merging this PR because
- Something is broken after the changes.
- Acceptance criteria is not reached.
- Code is dirty.
When to comment (neither ✅ nor ❌)
You want your comments to be addressed before merging this PR in cases like:
- There are leftovers like unnecessary logs, comments, etc.
- You have an opinionated comment regarding the code that requires a discussion.
- You have questions.
How to handle the comments?
- An owner of a comment is the only one who can resolve it.
- An owner of a comment must resolve it when it's addressed.
- A PR owner must reply with ✅ when a comment is addressed.
⚠️ No Changeset found
Latest commit: d408e4b100949e6c17923eed0a2521060e724821
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
Click here to learn what changesets are, and how to add one.
Click here if you're a maintainer who wants to add a changeset to this PR