mirror of
https://github.com/storybookjs/storybook.git
synced 2025-04-04 11:11:06 +08:00
7a32c16cfd
When I checked "How to contribute" page on storybook.js.org, a link titled "Continue reading our contributor covenant" pointed to GitHub's 404 page. The last item of the URL path was "CODE_OF_CONDUCT.mdx", which is not common filename people uses, therefore I suspected this is not the only broken link in the docs. And I was right. I ran the below command (rg = RipGrep) then found several 404 links. ``` $ cd docs $ rg "https?:[\S)]+mdx\)" --sort path ``` Git blame told me that some of ".md" to ".mdx" migration works accidentally changed non-docs URLs ending with ".md" too. StackBlitz URL in docs/api/main-config/main-config-indexers.mdx is not actually a dead link, as the service redirects to the `README.md`. However, the redirection takes loooong so I replaced that as well. There are still two links that match to the above regexp: * <https://github.com/storybookjs/storybook/blob/next/docs/get-started/setup.mdx> at docs/contribute/documentation/new-snippets.mdx L42 * <https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx> at docs/writing-docs/mdx.mdx but those two are both valid (alive) URLs.
29 lines
1.6 KiB
Plaintext
29 lines
1.6 KiB
Plaintext
---
|
|
title: 'How to contribute'
|
|
hideRendererSelector: true
|
|
sidebar:
|
|
order: 11
|
|
title: Contribute
|
|
---
|
|
|
|
Storybook is a community-oriented open source project that welcomes contributions. Some of our most popular features started with a developer wanting to solve a problem for themselves.
|
|
|
|
## Contributor covenant
|
|
|
|
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation. [Continue reading our contributor covenant »](https://github.com/storybookjs/storybook/blob/next/CODE_OF_CONDUCT.md)
|
|
|
|
## Ways to contribute
|
|
|
|
* [**RFC process**](./RFC.mdx) for authoring feature requests
|
|
* [**Code**](./code.mdx) for features and bug fixes
|
|
* [**Frameworks**](./framework.mdx) to get started with a new framework
|
|
* [**Documentation**](./documentation/documentation-updates.mdx) for documentation improvements, typos, and clarifications
|
|
* [**Examples**](./documentation/new-snippets.mdx) for new snippets and examples
|
|
* [**Addons**](../addons/index.mdx) for new addons
|
|
|
|
## Not sure how to get started?
|
|
|
|
* [Chat in Discord `#contributing`](https://discord.com/channels/486522875931656193/839297503446695956)
|
|
* [Browse "good first issues" to fix](https://github.com/storybookjs/storybook/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
|
|
* [Submit a bug report or feature request](https://github.com/storybookjs/storybook/issues)
|