Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 2.07 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

48 lines (34 loc) · 2.07 KB

Description

Which part of the repository is this PR related to?

  • Community (texts, guidelines...)
  • Software (bug fix, linting, bundler...)
  • Slices or components
  • Website

Please include a summary of the feature, change or fix you provide. It should include:

  • Motivation and context
  • Description of the change
  • Required dependencies, if any

If you PR includes new slices, please add pictures and links here too!

Type of change

Please delete options that are not relevant to your current PR:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature/slice (non-breaking change which adds functionality)
  • new (atomic) component (non-breaking change which updates a low-level component)
  • atomic component fix (that would cause existing functionality to not work as expected)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update (website or Github)

How Has This Been Tested?

We don't necessarily expect unit tests coming with your pull request, especially if you're adding a slice. Moreover, our contributors can help you on this! For other changes, please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration!

Checklist

Please describe the advancement of your pull request:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • If a new slice was created, it respects our slice guidelines
  • My changes generate no new warnings (including linting warnings and errors)
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Free Text

This PR template may lack some important matters, feel free to add content here!