Skip to content

Documentation: Add contributing note for disabling actions in forks#23801

Merged
kylegach merged 5 commits into
storybookjs:nextfrom
johnhunter:docs-fork-repos
Aug 16, 2023
Merged

Documentation: Add contributing note for disabling actions in forks#23801
kylegach merged 5 commits into
storybookjs:nextfrom
johnhunter:docs-fork-repos

Conversation

@johnhunter
Copy link
Copy Markdown
Contributor

@johnhunter johnhunter commented Aug 11, 2023

What I did

  • Added a note about disabling actions when forking the repo. Most forks will be used to dev locally on the project and raise PRs so the actions don't make sense and will just cause errors.
  • Added an issues section to help contributors solve known issues.
  • Fixed a broken link to the contributing guide

How to test

Documentation only.
If required you can confirm contributing guide link does not 404.

Checklist

  • Make sure your changes are tested (stories and/or unit, integration, or end-to-end tests)
  • Make sure to add/update documentation regarding your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts
  • Make sure this PR contains one of the labels below.

["cleanup", "BREAKING CHANGE", "feature request", "bug", "build", "documentation", "maintenance", "dependencies", "other"]

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@johnhunter
Copy link
Copy Markdown
Contributor Author

Ok, failing on Danger JS 😳 - I made the docs changes in the GH site. I'll pull down the PR locally and have a look in a bit.

@jonniebigodes jonniebigodes added documentation ci:docs Run the CI jobs for documentation checks only. labels Aug 11, 2023
@johnhunter
Copy link
Copy Markdown
Contributor Author

Am getting errors running yarn start locally so moving this PR to draft until resolved.

@johnhunter johnhunter marked this pull request as draft August 11, 2023 12:33
@johnhunter
Copy link
Copy Markdown
Contributor Author

Ok, the failing CI on this PR is unrelated to my local issues so setting back to review.

@johnhunter johnhunter marked this pull request as ready for review August 11, 2023 13:07
@johnhunter johnhunter force-pushed the docs-fork-repos branch 2 times, most recently from 1bd4afc to b08e357 Compare August 13, 2023 15:10
@kylegach kylegach self-assigned this Aug 14, 2023
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Copy link
Copy Markdown
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Thanks for these improvements, @johnhunter!

I left some suggested further improvements for you to integrate, then we can merge.

Comment thread CONTRIBUTING.md
Copy link
Copy Markdown
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Nicely done! Thanks again, @johnhunter.

@kylegach kylegach merged commit 3a26f15 into storybookjs:next Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants