Skip to content

PR Checklist

Dmytro Vakuliuk edited this page Oct 9, 2023 · 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
    • it should be under lib directory

Readme

  • has a short description with an optional link to reference
  • has described Styles and Settings
    • describe default values(if it has)
    • describe all possible values(for select type)
  • has described Event Handlers and Bindable Properties
  • has described Actions
  • has XML code for Codeless examples
  • check grammar and translate with Grammarly and https://www.reverso.net/

Default values examples:

Type Value
Number 0, 100, -100
String "foo", "bar"
Boolean true, false
Object { prop1: 100, prop2: true, prop3: String }
Any of type String Boolean Number Object

If we should describe a property that accepts certain strings, we must write:

"foo" | "bar" | "buz"

For generating tables use: https://www.tablesgenerator.com/markdown_tables

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