add prerequisite pre-commit

[acsr]

make install without already installed command pre-commit results in an error:

...
# Install pre commit hook
npx yarn husky install
Usage Error: Couldn't find a script named "husky".

$ yarn run [--inspect] [--inspect-brk] [-T,--top-level] [-B,--binaries-only] <scriptName> ...
make: *** [install] Error 1

Most developers may already have pre-commit in their path. This PR add s a prequistes section an enhances the existing simple pointer to node.js.

Boilerplate taken from (as suggested by @stevepiercy):
https://6.docs.plone.org/_sources/plone.api/contribute.md

[mister-roboto]

Armin Stross-Radschinski the email address in your commit does not match an email in your GitHub account. Thus it is impossible to determine whether you have signed the Plone Contributor Agreement, which is required to merge this pull request.

Learn about the Plone Contributor Agreement: https://plone.org/foundation/contributors-agreement

If you have sent in your Plone Contributor Agreement, and received and accepted an invitation to join the Plone GitHub organization, then you might need to either add the email address on your Agreement to your GitHub account or change the email address in your commits. If you need to do the latter, then you should squash the commits with your matching email and push them.

Add more emails to your GitHub account:
https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account

Change the email address in your commits:
https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address

[stevepiercy]

I am a big fan of not copy-pasting docs, and instead referring to an authoritative source that is actively maintained. This reduces maintenance burden, but you would have to trust that the authoritative source will be around. In this case, I don't see plone.api going away anytime soon. See subsequent comment for an example of what I mean.

[stevepiercy]

Per discussion in Discord, pre-commit is not necessary after all, but I still like a Prerequisites section for the rest of the stuff.

Sorry for the noise. At least you have it installed on your system for when other Plone projects require it, which is quite a few due to plone/meta.

[stevepiercy]

Suggested change

	- Have a current version of Node.js installed.
	Have a current version of Node.js installed.
	See [Plone 6 Documentation](https://6.docs.plone.org/install/create-project-cookieplone.html#nvm) for installing nvm to manage versions of Node.js.

[stevepiercy]

Add some breathing room to see it's a new section.

Suggested change

	### Node.js
	### Node.js

[stevepiercy]

Now that this is a section instead of a wall of text, I don't think bullet points are necessary. Your call.

Suggested change

	- To install, run: `make install`.
	To install, run: `make install`.

...and repeat down the file.

[acsr]

Armin Stross-Radschinski the email address in your commit does not match an email in your GitHub account. Thus it is impossible to determine whether you have signed the Plone Contributor Agreement, which is required to merge this pull request.
...
Add more emails to your GitHub account: https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/adding-an-email-address-to-your-github-account

I checked it an the address in the git log:

Author: Armin Stross-Radschinski <[email protected]>
Date:   Wed Feb 12 11:24:21 2025 +0100

    add prerequisite pre-commit

and it is my primary github mail address.
Maybe in the Plone Organisation this not properly matching with the entry for the contributor agreement. But i access Plone.org with my github account and running Pull requests dirctly from github works fine.

[stevepiercy]

Per discussion in Discord, pre-commit is not necessary after all, but I still like a Prerequisites section for the rest of the stuff.

Sorry for the noise. At least you have it installed on your system for when other Plone projects require it, which is quite a few due to plone/meta.

[stevepiercy]

and it is my primary github mail address. Maybe in the Plone Organisation this not properly matching with the entry for the contributor agreement. But i access Plone.org with my github account and running Pull requests dirctly from github works fine.

AFAIK, mr-roboto only checks GitHub usernames for being a member of a Plone Team on GitHub. You're a member of the Plone Developers Team. See relevant code:

https://github.com/plone/mr.roboto/blob/ae201dc3092258a73039ff94ab96b00296eb060a/src/mr.roboto/src/mr/roboto/subscriber.py#L192-L197

Maybe this was a false report? You can try to push another commit and see if it was a temporary glitch.

Do you have another commit in another Plone repo against which we can compare? Documentation does not use mr-roboto, but almost every other Plone repo should be a good sample.

[acsr]

Do you have another commit in another Plone repo against which we can compare? Documentation does not use mr-roboto, but almost every other Plone repo should be a good sample.

I mostly contribute to docs. No idea when I lastly committed a PR to a Plone Core Repo if ever (if ever, it was maybe before the great namespace changes) and of course the collective (when Plone Help Center was alive)

[acsr]

see #1427 for the ongoing error followup trying to work around the install issue.

[stevepiercy]

The collective organization does not require the Plone Contributor Agreement for contributions, and therefore does not use mr-roboto.

Author: Armin Stross-Radschinski <[email protected]>
Date:   Wed Feb 12 11:24:21 2025 +0100

    add prerequisite pre-commit

and it is my primary github mail address.

On your GitHub profile, you have a different email address of [email protected]. Looks like you transposed the parts in your username around the ..

[petschki]

husky got removed from @patternslib/dev ... closing this in favor of #1428