From 580c4c77f2fe40d588a366daf4f22246eed83fda Mon Sep 17 00:00:00 2001 From: Hilary Luo Date: Mon, 14 Jul 2025 16:23:40 -0400 Subject: [PATCH 1/3] Fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fbeb007e4..43971053e 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ Note, we used to suggest the command `npm run format-write` to update all the files in this repository. We don't suggest this command anymore, since it is then difficult for reviewers of Pull Requests to find the intended content changes. - If you do continue to use this entire repositry command, you may see files that claim to be updated in Source Control, but don't have any visible changes. + If you do continue to use this entire repository command, you may see files that claim to be updated in Source Control, but don't have any visible changes. If so, you should run these commands in your terminal to prevent Git from noting these types of changes: git config --global core.filemode false From 6d4e4a4265734c87ebfaa4d6e3724d3ac4037310 Mon Sep 17 00:00:00 2001 From: Hilary Luo Date: Mon, 14 Jul 2025 16:24:17 -0400 Subject: [PATCH 2/3] prettier changes --- README.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 43971053e..b8dacb844 100644 --- a/README.md +++ b/README.md @@ -254,7 +254,7 @@ This helps Users know where they downloaded the file from later, as the asset is In an `img/` folder next to the markdown files where it will be used. 6. Files larger than 100 MB - + Files added to GitHub must be smaller than 100 MB—_(at time of writing in 2025-04)_. You will be able to commit a large file locally, but the push to GitHub will fail. We are storing large files in an Amazon S3 Bucket, rather than the cpr-documentation repository's `/static/assets` directory. @@ -262,13 +262,12 @@ This helps Users know where they downloaded the file from later, as the asset is To add a file: - * Sign into https://us-east-2.console.aws.amazon.com/s3/ . - * Navigate to the S3 Bucket `cpr-documentation-large-files `. - * Select the `Upload` button, and choose your local file. - * After the file has been uploaded, click on the new object, and copy its `Object URL`. + - Sign into https://us-east-2.console.aws.amazon.com/s3/ . + - Navigate to the S3 Bucket `cpr-documentation-large-files `. + - Select the `Upload` button, and choose your local file. + - After the file has been uploaded, click on the new object, and copy its `Object URL`. This is the public URL to access the file you uploaded. Note that this S3 Bucket is configured so all files' permissions are automatically set to public access. - ## How to merge branches into the Production branch? From bf563d597b9f77706eb9fd1d4cec1e82dfc02bbb Mon Sep 17 00:00:00 2001 From: Hilary Luo Date: Mon, 14 Jul 2025 16:26:28 -0400 Subject: [PATCH 3/3] added note on how to run prettier on a folder --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index b8dacb844..11e4f1b65 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,8 @@ You can fix the errors by running Prettier on a single file, with `npx prettier --write `. For example, you can run the command `npx prettier --write README.md` to format this README. + If you have added a new folder and need to format all files within it you can use the `*` wildcard, for example" `npx prettier --write folder/*` + - Refer to the _package.json_ to understand what this script calls. - Refer to the _.prettierrc.json_ to understand the rules Prettier is using when checking files.