Story Template - powerhome/playbook GitHub Wiki

User Story

As a Playbook user, I want ___ so that I ___

How does it work now?

  • It works only on rails pages

How should it work?

  • It should work everywhere

Acceptance Criteria

  • It should do this…it should do that
  • It should use these props names
  • It should be styled this way
  • It displays a doc examples for each prop setting
  • It has descriptions needed to explain how to use this kit. This might include importing libraries, for example.
  • It includes all spec tests (for rails kits)
  • It includes all spec tests (for react kits)
  • It contains a label that targets the correct update
  • It contains a screenshot of each doc example on the PR

Testing & Release

  • Add a Milano label
  • Merge to master after feedback has been addressed and approved code review.
  • The release team will make a release and update Nitro accordingly (no action from you is required)

Any other technical details?

  • Should any more details we have discussed be included?

Breaking Changes

Breaking changes are the things that cause the most problems & errors with the release. First, if you are unsure about whether a PR is breaking reach out to the Playbook team. Any deletion or rename of a prop is a breaking change unless it’s made backward compatible. Changes to prop types are also breaking. Changes to enum values can also be breaking depending on the use cases. Another clue for breaking changes is changes made to tests. If a PR includes a breaking change we need to treat it will considerable scrutiny. If possible help makes the PR backward compatible and adds comments about depreciation. The most ideal path is to first make changes backward compatible and flag for depreciation. We can then plan a future sprint to deprecate as well as handle any updates that need to be made in our sister apps.

Tags:

needs_refinement (has not been refined by the UXE team) DevOps (releases, docs related to setup, etc) Kit Updates (kit-specific stories, icon epic) Website Improvements (updates to site or libraries in the playbook-website) playbook iOS (playbook iOS epic) typescript (typescript epic) Docs (anything related to updating docs)