Skip to content

Conversation

@xristianstefanov
Copy link
Contributor

@xristianstefanov xristianstefanov commented Jan 17, 2022

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 detail. 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, depending on the component.
  • - Feature/component-specific articles - those articles explain the component-specific features, which do not suit 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.
  • Link from the Overview components list

@xristianstefanov xristianstefanov requested a review from a team January 17, 2022 00:34
@xristianstefanov xristianstefanov self-assigned this Jan 17, 2022
@github-actions
Copy link
Contributor

Hello @xristianstefanov,

Check the below option if you would like to automatically generate PR to production. The automation uses the branch for the cherry-pick, and then will delete the branch. Please, do not delete it manually.

  • create pr to production

@Stamo-Gochev Stamo-Gochev self-requested a review January 17, 2022 15:13
Copy link
Contributor

@Stamo-Gochev Stamo-Gochev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some minor suggestions.

Waiting on @telerik/blazor-support for an additional review.

@xristianstefanov xristianstefanov merged commit 2f4f30a into master Jan 18, 2022
@github-actions github-actions bot deleted the documentation-map-component branch January 18, 2022 15:22
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.

4 participants