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

Update start-frontend README #1216

Merged
merged 3 commits into from
Mar 21, 2024
Merged

Conversation

ptrkdan
Copy link
Collaborator

@ptrkdan ptrkdan commented Mar 14, 2024

Pull Request Checklist

  • I have checked that this pull request is not a duplicate of a pre-existing pull request
  • I have self-reviewed my changes
    • There are no spelling mistakes
    • There are no remaining debug log prints (i.e. console.log())
    • Comments were written for complex code
  • I have checked that all tests are passing (for bug fixes and enhancements)
    • CLI Test (npm run test:cli)
    • Unit Test (npm run test:modules)
    • E2E Test (npm run e2e)
  • I have added and/or modified relevant tests for my changes (for bug fixes and enhancements)
  • I have added and/or modified relevant documentations for my changes (if necessary)

Description

Context

Resolves #1181

The README for start-frontend did not have clear instructions for users.
Therefore, I've specified that the current README instruction is for developers, and added a new section for users.

@ptrkdan ptrkdan added the documentation Improvements or additions to documentation label Mar 14, 2024
@ptrkdan ptrkdan requested a review from jinmayamashita March 14, 2024 13:14
@ptrkdan ptrkdan self-assigned this Mar 14, 2024
@ptrkdan ptrkdan linked an issue Mar 14, 2024 that may be closed by this pull request
Copy link

changeset-bot bot commented Mar 14, 2024

🦋 Changeset detected

Latest commit: d8928a1

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
start-frontend Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Collaborator

@jinmayamashita jinmayamashita left a comment

Choose a reason for hiding this comment

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

LGTM, Thank you for creating it! There were no issues with the content!

@jinmayamashita jinmayamashita merged commit bd91375 into main Mar 21, 2024
1 check passed
@jinmayamashita jinmayamashita deleted the docs/update-start-frontend-readme branch March 21, 2024 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update start-frontend README
2 participants