Skip to content
This repository was archived by the owner on Nov 25, 2024. It is now read-only.

Conversation

nishtha53
Copy link

@nishtha53 nishtha53 commented Oct 31, 2022

What type of PR is this? (check all applicable)

  • Feature
  • Bug Fix
  • Documentation Update
  • Refactor
  • Optimization

Description

  • Added how to work with storybook section in readme.

QA Instructions, Screenshots, Recordings

Please replace this line with instructions on how to test your changes, a note
on the devices and browsers this has been tested on, 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 awesome
Forem Accessibility Docs.

Added/updated 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

Copy link
Owner

@nickytonline nickytonline 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 the pull request @nishtha53!

It looks like the npm modules weren't installed so prettier did not run which is why the pull requests checks are failing.

8:45:03 AM: > prettier --plugin-search-dir . --check . && eslint .
8:45:04 AM: Checking formatting...
8:45:04 AM: [warn] README.md
8:45:05 AM: [warn] Code style issues found in the above file. Forgot to run Prettier?
  1. Make sure you follow the guidelines to install the project locally, i.e. run npm install. See https://github.com/nickytonline/connect-four#local-development
  2. You'll need to run npm run format as it didn't run automatically when you committed your code initially.

Comment on lines 36 to 47

### How to work with Storybook?

1. Run the app with `npm run storybook`
2. How to build it by running? - `npm run build-storybook`
3. Story Book Official documentation
- [Guides](https://storybook.js.org/docs/react/get-started/introduction)

- [Tutorials](https://storybook.js.org/tutorials/)



Copy link
Owner

Choose a reason for hiding this comment

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

Just some wording changes. Also, I know I said add how to build it, but we can omit that. It's really only required for deploying Storybook.

Suggested change
### How to work with Storybook?
1. Run the app with `npm run storybook`
2. How to build it by running? - `npm run build-storybook`
3. Story Book Official documentation
- [Guides](https://storybook.js.org/docs/react/get-started/introduction)
- [Tutorials](https://storybook.js.org/tutorials/)
### Working with Storybook
1. To start Storybook, run `npm run storybook`
2. For more information on Storybook, see the Official documentation
- [Guides](https://storybook.js.org/docs/react/get-started/introduction)
- [Tutorials](https://storybook.js.org/tutorials/)

@nishtha53
Copy link
Author

Okay I will work on this changes

@nishtha53
Copy link
Author

@nickytonline in my local I have installed all packages and done with readme part still showing merging block

@nickytonline
Copy link
Owner

I'll pull down your pull request and see what's up.

@nishtha53
Copy link
Author

okay sure do let me know.

@nickytonline
Copy link
Owner

There's still some formatting errors but I can't push changes from my local machine as I do not have access to your branch.

From your local machine, do the following.

  1. Run git pull to pull down the changes I made.
  2. Run npm run format from the root of the project.
  3. Commit the file changes which should be just the ReadME.md file.
  4. Do a git push to push up the changes.

@nishtha53
Copy link
Author

@nickytonline I followed same steps which you told but same merging is still blocked.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a section to the ReadME for Storybook

2 participants