diff options
| author |  Vijay A <vraravam@users.noreply.github.com> | 2022-07-13 11:40:00 +0530 |
|---|---|---|
| committer | Vijay Aravamudhan <vraravam@users.noreply.github.com> | 2022-07-13 11:44:27 +0530 |
| commit | 25930162f339a7c5c119e7197726ad2507dee75a (patch) | |
| tree | 6b11f53a517292216702d6683f919f95acbaf18f /docs | |
| parent | Fix lint and prettier (diff) | |
| download | ferdium-recipes-25930162f339a7c5c119e7197726ad2507dee75a.tar.gz ferdium-recipes-25930162f339a7c5c119e7197726ad2507dee75a.tar.zst ferdium-recipes-25930162f339a7c5c119e7197726ad2507dee75a.zip | |
Update documentation [skip ci]
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/integration.md | 2 | ||||
| -rw-r--r-- | docs/updating.md | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/integration.md b/docs/integration.md index 9ff7011..843597c 100644 --- a/docs/integration.md +++ b/docs/integration.md | |||
| @@ -53,7 +53,7 @@ This command will automatically create the development recipe in the correct fol | |||
| 53 | 53 | ||
| 54 | 5. (Mandatory) Please run the following step before raising a PR: | 54 | 5. (Mandatory) Please run the following step before raising a PR: |
| 55 | ```Bash | 55 | ```Bash |
| 56 | pnpm package | 56 | pnpm i && pnpm lint && pnpm reformat-files && pnpm package |
| 57 | ``` | 57 | ``` |
| 58 | Fix any issues that are reported. | 58 | Fix any issues that are reported. |
| 59 | 59 | ||
diff --git a/docs/updating.md b/docs/updating.md index 3b835df..aeb2ffe 100644 --- a/docs/updating.md +++ b/docs/updating.md | |||
| @@ -31,6 +31,6 @@ Ferdium uses this version to determine if it should update the local copy of the | |||
| 31 | 31 | ||
| 32 | ## 5. Running the validation checks | 32 | ## 5. Running the validation checks |
| 33 | 33 | ||
| 34 | This might be the __most important step__ of this guide. You'll need to run the `pnpm package` command to ensure that all validation checks are run. | 34 | This might be the __most important step__ of this guide. You'll need to run the `pnpm lint && pnpm reformat-files && pnpm package` command to ensure that all validation checks are run. |
| 35 | 35 | ||
| 36 | ## 6. Commit your changes and create a PR to <https://github.com/ferdium/ferdium-recipes> | 36 | ## 6. Commit your changes and create a PR to <https://github.com/ferdium/ferdium-recipes> |