Skip to content

PR Checklist

Jump to bottom
Dmytro Vakuliuk edited this page Jul 8, 2022 · 8 revisions

Before opening PR:

  • run linter
  • run IDE formatting on all files
  • create README
  • check gitignore(must include dist)
  • if you use some external library, check if it compressed

Readme

  • has a short description with an optional link to reference
  • has described Styles and Settings
    • don't forget for default values(if they have)
  • has described Event Handlers and Bindable Properties
  • has described Actions
  • check grammar and translate with Grammarly and https://www.reverso.net/

component.json

  • has description
  • has a custom icon
  • has labels and handler descriptions
  • hasn't empty fields

PR should have:

  • name: BKNDLSS-<ticket-number> <component-name>
  • meaningful branch name(ex.: bl-test-component or bl-test-components-<ticket-number> for fixes)
  • screenshots of component with different themes/modes/options depend on component API.

Ticket:

  • leave PR link in comments
  • assign it to the reviewer
Clone this wiki locally