chore: update actions to use npm and dev guide#449
chore: update actions to use npm and dev guide#449lwasser merged 2 commits intoall-contributors:mainfrom
Conversation
|
once we merge #446 i think npm will be happier. |
3913a94 to
4b3348f
Compare
4b3348f to
96fb44b
Compare
| steps: | ||
| - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | ||
|
|
||
| - name: Setup pnpm |
There was a problem hiding this comment.
I am game to move to pnpm in the future but right now we should be consistent and move everything if we plan to move. otherwise we have a lock file that is only for us locally and a different potential environment in ci.
| - **Node.js** 22 or later (see `engines` in `package.json`) | ||
| - **npm** (the project uses npm which produces a `package-lock.json`) | ||
|
|
||
| ## Development commands |
There was a problem hiding this comment.
Nit? We do we upper case some words, but not others. For example, "Development Documentation" but "Development commands"
There was a problem hiding this comment.
Oops - that is a mistake. i thought i had caught that and was trying to use sentence case throughout. i'll fix that before i merge this likely tomorrow. Good catch!!
There was a problem hiding this comment.
Ok! i've fixed it. The only thing I did not fix is that H1 is technically a title. And so i've been using title case for titles and then headings get sentence case!! we can definitely change that - maybe in the main docs to see what's there to ensure it's consistent. It's likely that i was not consistent there!! thank you for the catch!!
| @@ -1,28 +1,64 @@ | |||
| # Development Documentation | |||
|
|
|||
There was a problem hiding this comment.
Might be worth having a ToC. Scrolling is ouff haha
There was a problem hiding this comment.
I hear ya!! The plan will be to move this page to our astro documentation here:
https://allcontributors.org/cli/overview/
So if you are ok with that - we will then have a nice toctree on the right hand side with subsection links!!
it just felt easer to update this file here as we want then creating pr's to the docs repo each time. 🙃 but i totally agree!!
There was a problem hiding this comment.
Makes sense, sounds good
jdalrymple
left a comment
There was a problem hiding this comment.
No blockers, just suggestions. LGTM
JoshuaKGoldberg
left a comment
There was a problem hiding this comment.
Nothing extra from me that hasn't already been said 😎
| `ALL_CONTRIBS_RELEASE_PLEASE_TOKEN` (scoped to the all-contributors org and CLI | ||
| repo). The same pattern could be extended to the app repo later if needed. | ||
|
|
||
| ### Release process |
There was a problem hiding this comment.
Fix same header as above...
|
Thanks for the review, friends! Merging now! |
While reading the updating the dev guide i found a few inconsistencies so I did a cleanup here. So this pr does a few things
What:
Docs and consistency across our builds
Why:
How:
Checklist: