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

Fix minor mistakes in the root README #8242

Merged
merged 1 commit into from
May 14, 2024

Conversation

dlarocque
Copy link
Contributor

I noticed some small mistakes in the README.md, this PR fixes them.

@dlarocque dlarocque requested a review from a team as a code owner May 13, 2024 14:58
Copy link

changeset-bot bot commented May 13, 2024

⚠️ No Changeset found

Latest commit: 331d234

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

@@ -204,7 +207,7 @@ In order to manually test your SDK changes locally, you must use [yarn link](htt
```shell
$ cd packages/firebase
$ yarn link # initialize the linking to the other folder
$ cd ../packages/<my-product> # Example: $ cd packages/database
$ cd ../<my-product> # Example: $ cd ../firestore
Copy link
Contributor

Choose a reason for hiding this comment

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

I have to admit I've never used the yarn link method of building/linking to an app. I think was correct to begin with, no? The firestore implementation is within packages/firestore in our repo.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The first step brings you into packages/firebase, then this step says you should cd ../packages/<product>, which would end up being packages/packages/<product>. So it's just a small hiccup that I noticed when I was going through the steps myself.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh I see!

@google-oss-bot
Copy link
Contributor

@google-oss-bot
Copy link
Contributor

@dlarocque dlarocque merged commit 9cbb184 into master May 14, 2024
36 checks passed
@dlarocque dlarocque deleted the dlarocque/readme-improvements branch May 14, 2024 13:26
@firebase firebase locked and limited conversation to collaborators Jun 14, 2024
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.

3 participants