Skip to content

Commit

Permalink
docs(project): add new contributing info
Browse files Browse the repository at this point in the history
  • Loading branch information
InteractiveTimmy committed Apr 9, 2024
1 parent 75edfd8 commit 8c9e89e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ This project also has some additional requirements that are (sometimes) optional
* [JQ](https://github.com/stedolan/jq#jq) - *used for processing JSON in terminal, install as necessary*
* [libcrypt](https://gnupg.org/software/libgcrypt/index.html) - *general purpose cryptography, install as necessary*
* [graphicsmagick](http://www.graphicsmagick.org/) - *image processor, install as necessary*
* [FireFox](https://www.mozilla.org/en-US/firefox/) - *browser, required for browser testing*
* [Chrome](https://www.google.com/chrome/) - *browser, required for browser testing*

#### Downloading

Expand Down
3 changes: 2 additions & 1 deletion SCRIPTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Below is a list of project scripts that can be ran from the root of this project
* `yarn @legacy {script} {...args}` - Run the provided script on all modules within the `legacy` scope.
* `yarn @legacy-tools {script} {...args}` - Run the provided script on all modules within the `legacy-tools` scope.
* `yarn @tools {script} {...args}` - Run the provided script on all modules within the `tools` scope.
* `yarn @workspaces {...args}` - Run the provided arguments against all workspaces with a common arglist
* `yarn @workspaces {...args}` - Run the provided arguments against all workspaces with a common arglist.
* `yarn prebuild:modules` - Run to process all prebuilding workflows in the correct order.

Outside of these project scripts, general usage of [Yarn Workspace](https://yarnpkg.com/features/workspaces) commands. from the root level to access and iterate over all of its respective packages.

Expand Down

0 comments on commit 8c9e89e

Please sign in to comment.