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.

Sign up for GitHub

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

Docs: Explain how to clean local files for contributers #24630

Merged
merged 5 commits into from
Dec 12, 2023
Merged

Docs: Explain how to clean local files for contributers #24630

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a27c2c7
Explain how to clean local files for contributers
bodograumann Oct 31, 2023
163d347
Merge branch 'next' into docs-contributer-returns
jonniebigodes Dec 11, 2023
4282571
Merge branch 'next' into docs-contributer-returns
jonniebigodes Dec 12, 2023
441ccac
Update CONTRIBUTING.md
bodograumann Dec 12, 2023
72a0423
Merge branch 'next' into docs-contributer-returns
jonniebigodes Dec 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,13 @@ If you run `yarn start` and encounter the following error, try rerunning `yarn s
```sh
> NX ENOENT: no such file or directory, open 'storybook/code/node_modules/nx/package.json'
```
If you are a Storybook contributor and still experience issues, it is recommended that you verify your local Storybook instance for any unintentional local changes and left-overs. To do this, you can use the following command:

Copy link
Contributor

Choose a reason for hiding this comment

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

@bodograumann when you're able, can you adjust this to be:
"If you are a Storybook contributor and still experience issues, it is recommended that you verify your local Storybook instance for any unintentional local changes. To do this, you can use the following command:"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good to me. Have copied your version of the sentence verbatim.

```sh
git clean -dx --dry-run
```

By executing this command, you will be able to see which untracked or ignored files and directories will be removed from your working directory if you run it with the `--force` flag. Before running the command with the `--force` flag, please commit any local changes that you want to keep. Otherwise they will be lost.

## Forked repos

Expand Down