You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -36,8 +36,8 @@ The workflow for updating the Super Rentals Tutorial involves working within two
36
36
37
37
Once you have made your changes in the tutorial prose or code, you can run a few different commands to verify that your changes render as expected.
38
38
39
-
* To regenerate all of the chapters (and rebuild the app), run `yarn build`. This will `rm -rf` anything previously generated in the `/dist` directory.
40
-
* To generate a single chapter without removing all the previously generated content, run `yarn generate src/markdown/07-your-chapter-to-edit-here.md`. This will rebuild _just_ the chapter that is specified without deleting everything else in the `/dist` directory. Please note that, before running this command, the _current state_ of the `/dist/code` directory has to match the precise state of what it would be after running the generate command on the previous chapter. In other words, in order for the generate command to work correctly, the state of the code in `/dist/code` should match exactly the code that would be generated by `yarn generate src/markdown/06-the-previous-chapter.md` before it is run for `src/markdown/07-your-chapter-to-edit-here.md` .
39
+
* To regenerate all of the chapters (and rebuild the app), run `pnpm build`. This will `rm -rf` anything previously generated in the `/dist` directory.
40
+
* To generate a single chapter without removing all the previously generated content, run `pnpm generate src/markdown/07-your-chapter-to-edit-here.md`. This will rebuild _just_ the chapter that is specified without deleting everything else in the `/dist` directory. Please note that, before running this command, the _current state_ of the `/dist/code` directory has to match the precise state of what it would be after running the generate command on the previous chapter. In other words, in order for the generate command to work correctly, the state of the code in `/dist/code` should match exactly the code that would be generated by `pnpm generate src/markdown/06-the-previous-chapter.md` before it is run for `src/markdown/07-your-chapter-to-edit-here.md` .
41
41
42
42
### Code changes
43
43
@@ -82,7 +82,7 @@ When running commands, generating new files, or making changes to preexisting on
82
82
For example:
83
83
84
84
```run:pause
85
-
Note to self: check that `application.hbs` has the correct markup and remember to git add it!
85
+
Note to self: check that \`application.hbs\` has the correct markup and remember to git add it!
86
86
```
87
87
88
88
Any content inside of the code blocks will be printed in your command line.
@@ -133,7 +133,7 @@ In both cases, be sure your editor is not set to trim trailing whitespace on lin
133
133
Once you have added the diff to the prose using the `run:file:patch` command, you can remove the `run:pause` command. In order to test that your patch was successfully applied, be sure to:
134
134
135
135
1. Run `git checkout` any changes in the working directory of `/dist/code/super-rentals/code`.
136
-
2. Regenerate your modified chapter (`yarn generate src/markdown/00-your-chapter-to-edit-here.md`).
136
+
2. Regenerate your modified chapter (`pnpm generate src/markdown/00-your-chapter-to-edit-here.md`).
137
137
138
138
Finally, you can look at your modified chapter in `/dist/markdown` and make sure that your patch renders as you expect in the markdown!
0 commit comments