picasso icon indicating copy to clipboard operation
picasso copied to clipboard

Add package generator

Open mkrl opened this issue 1 year ago • 1 comments

[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:package and 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)
  • Look for any of the required files that are missing in the generated package

Development checks

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

  1. You have no extra requests.
  2. You have optional requests.
    1. Add nit: to your comment. (ex. nit: I'd rename this variable from makeCircle to getCircle)

When to request changes? ❌

You are not OK with merging this PR because

  1. Something is broken after the changes.
  2. Acceptance criteria is not reached.
  3. Code is dirty.

When to comment (neither ✅ nor ❌)

You want your comments to be addressed before merging this PR in cases like:

  1. There are leftovers like unnecessary logs, comments, etc.
  2. You have an opinionated comment regarding the code that requires a discussion.
  3. You have questions.

How to handle the comments?

  1. An owner of a comment is the only one who can resolve it.
  2. An owner of a comment must resolve it when it's addressed.
  3. A PR owner must reply with ✅ when a comment is addressed.

mkrl avatar Aug 14 '24 17:08 mkrl

⚠️ 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

changeset-bot[bot] avatar Aug 14 '24 17:08 changeset-bot[bot]