Skip to content

Conversation

@marin-bratanov
Copy link
Contributor

@marin-bratanov marin-bratanov commented Mar 11, 2021

New Component Checklist (delete for other types of PRs)

  • - Overview article

    • General information on the purpose of the component.
    • Instruction on how to add the component to a razor component.
    • Basic configuration of the component - code snippet with a scenario that is both basic, and meaningful.
    • Provide information on the component's reference.
    • List the available features for the component and/or provide links (slugs) for the articles that explain them in details. For simpler components listing parameters might be enough, for more complex ones sections with a sentence or two that links corresponding articles might be more suitable.
    • Maybe some Example(s) - very common scenarios, notes, typical use case, etc. Not mandatory, depends on the component.
  • - Data binding article - applicable if data can be provided to the component. My be one article or a folder with several articles (examples - DropDownList and TreeView)

  • - Feature/component specific articles - those articles explain the component specific features, which do not suit in any of the before-mentioned articles. Examples of such articles are the Navigator for the Stock Chart, the Indeterminate state for the CheckBox and others.

  • - Events article - applicable if the component expose events.
    Examples of such events could be:

  • OnClick
  • OnChange
  • ValueChanged
  • SelectedItemsChanged
  • OnRead
  • etc.
  • Update Input Validation, Globalization, Keyboard Navigation, Accessibility Compliance articles as applicable.

  • Link from the Overview components list

@marin-bratanov marin-bratanov self-assigned this Mar 11, 2021
@marin-bratanov marin-bratanov changed the title chore(colorPalette): skeleton colorPalette initial docs Mar 13, 2021
@marin-bratanov marin-bratanov marked this pull request as ready for review March 16, 2021 16:44
@marin-bratanov marin-bratanov merged commit 7f010ae into master Mar 17, 2021
@marin-bratanov marin-bratanov deleted the colorpalette-initial branch March 17, 2021 12:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants