Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add contributing instructions to PULL_REQUEST_TEMPLATE #17713

Merged
merged 2 commits into from Mar 28, 2022
Merged

Add contributing instructions to PULL_REQUEST_TEMPLATE #17713

merged 2 commits into from Mar 28, 2022

Conversation

wesleyboar
Copy link
Contributor

@wesleyboar wesleyboar commented Mar 15, 2022

Issue: An ignorant new contributor may not see the "Helpful resources" links (example: #17703).

What I did

Add helpful link about contribution to the PR description. (This may help new contributors who only read the template.)

What I thought about doing…
  • I thought about writing For additional guidance, see https://github.com/storybookjs/storybook/blob/next/CONTRIBUTING.md, but then there's the weird period-after-a-link legibility and usability issue.
  • I also used the word "guidance" instead of "direction" so as to suggest more that the contributor has a choice (because everyone is sensitive nowadays).

How to test

Might not be testable.

Change is in a PR template, so I don't think it is usable without being in master.
Change is in a comment, so it will not render in a preview of the document.

  • Is this testable with Jest or Chromatic screenshots?
  • Does this need a new example in the kitchen sink apps?
  • Does this need an update to the documentation?

If your answer is yes to any of these, please make sure to include it in your PR.

Add helpful link about contribution to the PR description.
This may help contributors who only read the template.
@nx-cloud
Copy link

nx-cloud bot commented Mar 15, 2022

☁️ Nx Cloud Report

CI ran the following commands for commit 3470b0e. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@wesleyboar wesleyboar changed the title PULL_REQUEST_TEMPLATE, mention external resource In PULL_REQUEST_TEMPLATE Mention CONTRIBUTING.md Mar 15, 2022
@wesleyboar
Copy link
Contributor Author

Closes #17703

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Great idea @tacc-wbomar!! But what do you think about linking directly to the updated guide here? https://storybook.js.org/docs/react/contribute/how-to-contribute

@wesleyboar
Copy link
Contributor Author

@shilman, Thanks for looking. I've made that change. I do have reservations.

  • The website document URL has react in it, but is not limited to react. Were I a careful reader, and contributing to not-react code, I might think that is the wrong document for me.
  • Will the CONTRIBUTING.md doc become useful? It mentions transition but perhaps that means it will be deprecated not improved.

@MichaelArestad MichaelArestad added the maintenance User-facing maintenance tasks label Mar 21, 2022
Copy link
Member

@yannbf yannbf left a comment

Choose a reason for hiding this comment

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

Hey @tacc-wbomar thank you so much for your contribution!

The website document URL has react in it, but is not limited to react. Were I a careful reader, and contributing to not-react code, I might think that is the wrong document for me.

This is just how our documentation website works, given that docs have to be based on a framework. That could be any framework, it will result in the same contribution page regardless.

Will the CONTRIBUTING.md doc become useful? It mentions transition but perhaps that means it will be deprecated not improved.

I believe it will just point people to the website

@shilman shilman changed the title In PULL_REQUEST_TEMPLATE Mention CONTRIBUTING.md Add contributing instructions to PULL_REQUEST_TEMPLATE Mar 28, 2022
@shilman shilman merged commit 94812d1 into storybookjs:next Mar 28, 2022
@wesleyboar wesleyboar deleted the patch-3 branch March 31, 2022 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants