Skip to content

Commit

Permalink
chore:docs Adding back references to yarn build (#31480)
Browse files Browse the repository at this point in the history
Co-authored-by: Mitch-At-Work <mifraser@microsoft.com>
  • Loading branch information
mltejera and Mitch-At-Work committed Jun 3, 2024
1 parent 0c893e4 commit 80e5bbd
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/react-v9/contributing/command-cheat-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ yarn create-package # scaffolds a new package
yarn create-component # scaffolds a new component
yarn change # creates a new change file, if needed
yarn clean # tidies any cached dependencies
yarn build # generates and relinks all packages and temporary files, this can be a good option if you see errors unrelated to the packages you are working on
yarn start # runs a package. You can select the package of choice.
yarn update-snapshots # updates snapshot tests
yarn run dedupe # dedupes dependencies - necessary to run after any kind of package bump/changes
Expand Down
6 changes: 5 additions & 1 deletion docs/react-v9/contributing/common-dev-snags.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,15 @@ First, file an issue [here](https://github.com/microsoft/fluentui/issues/new/cho

Make sure all your desired changes are stashed or otherwise saved somewhere you can pull them back in.

First try running:
Then try running:

`yarn`

If the issues still persist, clean your repo:

`yarn cache clean`
`yarn`

If unrelated errors are still persistent, a clean build may resolve:

`yarn build`
1 change: 1 addition & 0 deletions docs/react-v9/contributing/dev-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ This document describes how to set up your development environment and contribut
- Optional: **[Accessibility insight for web](https://accessibilityinsights.io/)**
- Optional: **[Node Version Manager](https://github.com/nvm-sh/nvm)**
- Optional: **[CSpell VS Code Extension](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker)**
- Optional: **[Improve build times: WSL for Windows](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl)**

### Verify your environment

Expand Down
4 changes: 4 additions & 0 deletions docs/react-v9/contributing/dev-workflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ cd fluentui
yarn
```

Windows users not working in WSL should run `yarn clean` and then `yarn build` on first use to ensure correct linking in non-\*nix systems.

Run `yarn start` and select your start up project.

```
Expand Down Expand Up @@ -57,6 +59,7 @@ It is strongly recommended that you rebase your branch onto (rather than merging
```
git checkout master // Switches to master
git pull upstream master // Syncs your local master with the latest version of master at the origin
git push // syncs your forks definition of master with the upstream repo
git checkout your-fancy-branch // Switches back to your branch
git rebase -i master // Tacks your commits onto the end of master. Force is necessary since rebase changes history.
```
Expand All @@ -76,6 +79,7 @@ In other cases, such as before checking in or running tests, you may need to run
### Making a pull request

Make sure all your changes are committed, and run `yarn nx run @fluentui/react-components:build` or `yarn buildto @fluentui/react-components` for changes to the v9 components. This will compare your changes and detect if the publicly facing API has changed, and update our API docs accordingly. Commit this file change.
Note: If you encounter build errors here (especially on non-\*nix systems) a 'yarn build' to ensure packages are correctly updated and linked may be nessecary.

Some of our tests make use of DOM snapshot tests. If your branch makes any changes or additions to the DOM, you may need to run `yarn nx run @fluentui/<package>:test -u` or `yarn workspace @fluentui/<package> test --updateSnapshot`. This will update any necessary files used by our snapshot tests.

Expand Down

0 comments on commit 80e5bbd

Please sign in to comment.