[REVIEW] Add pre-commit hook for DCO and pre-commit check

[VibhuJawa]

This pull request introduces improvements to the .pre-commit-config.yaml file, focusing on enhancing the pre-commit hook configuration. This PR closes: #290

Key updates:

• Ensure commits are signed-off, enforcing commit message compliance.
• Remind developers to install pre-commit hooks if missing, reducing setup errors.

Example Usage:

(nemo_curator_dev) vjawa@dgx11:~/NeMo-Curator$ git add .pre-commit-config.yaml
(nemo_curator_dev) vjawa@dgx11:~/NeMo-Curator$ git commit -m 'check if signoff warning is raised'

check for added large files..............................................Passed
check for case conflicts.................................................Passed
check yaml...............................................................Passed
detect private key.......................................................Passed
fix end of files.........................................................Passed
Pre-commit Installation Reminder.........................................Passed
Check Signed-off-by......................................................Failed
- hook id: check-signoff
- exit code: 1

❌ Commit message must be signed off. Use git commit -s to add it automatically.

Additional example of running pre-commits

(base) vjawa@dgx11:~/NeMo-Curator$ git commit -m 'check if signoff warning is raised'
`pre-commit` not found. Did you forget to activate your virtualenv?

[ryantwolf]

Looks good on my end. Is there a similar way we can check for signing commits using -S?

[VibhuJawa]

Looks good on my end. Is there a similar way we can check for signing commits using -S?

Unsure what you mean here. This is all ready run at a per commit level is my understanding.

[ryantwolf]

This precommit checks for -s if I'm not mistaken. We need the user to sign and sign-off their commits using git commit -sS. Is there any way for the gpg signing to be detected in the precommit?

[VibhuJawa]

Is there any way for the gpg signing to be detected in the precommit?

Ahh, cool, let me see how to add that too.

[VibhuJawa]

@ryantwolf , I checked but could not find a satisfactory way to check for GPG. I think lets merge this PR as is, I will file an issue to track a cleaner way to sign GPG

[ryantwolf]

@VibhuJawa ok no worries, I was just curious. This is still good on my end, so feel free to merge whenever.