Skip to content

PR Review Checklist

hanjunt edited this page May 21, 2021 · 10 revisions

PR Review Checklist For Fundamental-NGX:

  • Code style (following Guideline)
    • Using proper naming convention
    • Using proper access modifiers
    • Grouping class body elements in proper order
    • No unguarded subscriptions
    • Granularity of code (example)
    • Type-safe code
    • Component API documentation
    • No Console logs
    • OnPush strategy on all of the components
    • All of public methods should be commented
  • For custom input controls
    • Test with async data
    • Test Dirty/Touched states
    • Test number and content of valueChanges ngModelChange events
    • Test with dynamically changing data (like changing Select options in runtime)
  • Component properly implementing CssClassBuilder or CssStyleBuilder
  • Accessibility - account for keyboard support, screenreader support, proper ARIA attributes, roles, etc.
  • RTL support
  • For composite components - examples are updated everywhere
  • Units tests for all of new functionalities
  • New Files should be shared in public_api.ts and in api-files.ts for TypeDocs
  • Check for differences in visual between styles and ngx
Clone this wiki locally