docs(contributing): Note Conventional Commits and tips for complying #634
Conversation
Include hints on locally linting commit messages.
Summarize contributor guidance now that we have >2 things to say.
apetro
requested review from
davidmsibley,
Doug-Reed,
ChristianMurphy and
vertein
|
|
||
| You can locally lint your commit messages via a pre-commit hook by | ||
|
|
||
| 1. Setting `"commitmsg": "commitlint -e",` in your local `package.json` |
There was a problem hiding this comment.
Is this still needed since this is included in the package.json already?
There was a problem hiding this comment.
Yes? commitmsg does not appear in the package.json as of https://github.com/uPortal-Project/uportal-app-framework/pull/581/files#diff-b9cfc7f2cdf78a7f4b91a753d10865a2L6 's removing it?
There was a problem hiding this comment.
Oh, I see. I'd inadvertently re-added this to package.json in this changeset. Hasn't meant to include that change; fixed.
| You can locally lint your commit messages via a pre-commit hook by | ||
|
|
||
| 1. Setting `"commitmsg": "commitlint -e",` in your local `package.json` | ||
| 2. Having a `.git/commit-msg` script that honors the `package.json` |
There was a problem hiding this comment.
This could work, I added some notes at #535 (comment) on how this could be normalized to remove some of the manual effort.
.github/CONTRIBUTING.md
Outdated
| @@ -1,5 +1,9 @@ | |||
| # Contributing to `uportal-app-framework` | |||
|
|
|||
| + Be kind. (Uphold the Code of conduct). | |||
There was a problem hiding this comment.
❓ maybe include reference link to Code of conduct here?
.github/CONTRIBUTING.md
Outdated
| @@ -1,5 +1,9 @@ | |||
| # Contributing to `uportal-app-framework` | |||
|
|
|||
| + Be kind. (Uphold the Code of conduct). | |||
| + Be an ICLA signatory. (Comply with Apereo licensing policy). | |||
There was a problem hiding this comment.
❓ maybe include reference link to licencing policy here?
apetro
force-pushed
the
document-commit-msg-linting
branch
from
15035bb to
936e25a
Compare
Fixes #633 .
Acknowledges in
CONTRIBUTING.mdthat we're trying to do Conventional Commits.Adds hints on how to locally lint commit messages and even on how to automate this.
I think the hints work in that I locally followed my own instructions to re-add this pre-commit hook. (To be fair I was only able to do this by cribbing from the PR that removed the hook ( #581 ), so, hurray for clear, discoverable change history.).
Funny anecdote: The hook caught problems with my initial commit message attempt for
bothall three of these commits. Writing in Sentence case with a full stop. it's an ingrained habit.Contributor License Agreement adherence: