ea00c808bd
* Update naming of guidelines section and improve Introduction page * Add Docs * Add docs * Install Docs add-on - Rename top-level folders and sort manually - Add MDX static pages * Updated all Storybook addons to 6.1.3 except for notes as it's currently 5.3.21 * Fixed naming of section for the select component. * Updated yarn.lock file. * Added missing dependency @storybook/addon-docs Co-authored-by: Nick Taylor <nick@dev.to>
56 lines
2 KiB
Markdown
56 lines
2 KiB
Markdown
<!--
|
|
For Work In Progress Pull Requests, please use the Draft PR feature,
|
|
see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details.
|
|
|
|
For a timely review/response, please avoid force-pushing additional
|
|
commits if your PR already received reviews or comments.
|
|
|
|
Before submitting a Pull Request, please ensure you've done the following:
|
|
- 📖 Read the Forem Contributing Guide: https://github.com/forem/forem/blob/master/CONTRIBUTING.md#create-a-pull-request.
|
|
- 📖 Read the Forem Code of Conduct: https://github.com/forem/forem/blob/master/CODE_OF_CONDUCT.md.
|
|
- 👷♀️ Create small PRs. In most cases this will be possible.
|
|
- ✅ Provide tests for your changes.
|
|
- 📝 Use descriptive commit messages.
|
|
- 📗 Update any related documentation and include any relevant screenshots.
|
|
-->
|
|
|
|
## What type of PR is this? (check all applicable)
|
|
|
|
- [ ] Refactor
|
|
- [ ] Feature
|
|
- [ ] Bug Fix
|
|
- [ ] Optimization
|
|
- [ ] Documentation Update
|
|
|
|
## Description
|
|
|
|
## Related Tickets & Documents
|
|
|
|
## QA Instructions, Screenshots, Recordings
|
|
|
|
_Please replace this line with instructions on how to test your changes, as well
|
|
as any relevant images for UI changes._
|
|
|
|
### UI accessibility concerns?
|
|
|
|
_If your PR includes UI changes, please replace this line with details on how accessibility is impacted and tested. For more info, check out the [Forem Accessibility Docs](https://docs.forem.com/frontend/accessibility)._
|
|
|
|
## Added tests?
|
|
|
|
- [ ] Yes
|
|
- [ ] No, and this is why: _please replace this line with details on why tests
|
|
have not been included_
|
|
- [ ] I need help with writing tests
|
|
|
|
## Added to documentation?
|
|
|
|
- [ ] [Developer Docs](https://docs.forem.com) and/or
|
|
[Admin Guide](https://forem.gitbook.io/forem-admin-guide/)
|
|
- [ ] README
|
|
- [ ] No documentation needed
|
|
|
|
## [optional] Are there any post deployment tasks we need to perform?
|
|
|
|
## [optional] What gif best describes this PR or how it makes you feel?
|
|
|
|
|