-
-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: add contribution guide #29
Comments
And of course, my favorite is configuring the repo to use squashing, and use the title of the PR for the squashed commit. Then it's easier to read the whole commit history, and the rule only has to be applied one place. |
I'll write the contrib guide. Regarding the config. Squashing is OK. PR Title: Done this and this for this and this Fixes #36 Feel free to reconfigure the repo for squash commits @rfay - don't have much experience with that 😅 |
Generally speaking - Commit msg validation workflow is a bit overkill. Husky + commitizen can (and should) be used to enforce commits with hooks.
Will make a contributing.md and set everything up. |
If you have a requirement for the resultant squashed commit, I recommend that you go in there and click on "default message" and change it to what you like: IMO, requiring a specific (readable) format for the title is the easiest way to go. We use this technique and just enforce the PR title. But of course, you get to do it the way you like. https://ddev.readthedocs.io/en/stable/developers/building-contributing/#pull-request-title-guidelines |
You're becoming my favourite person on GH 😊😊😊 |
Has this stalled? |
A comment on #26 requested commit messages follow "Semantic Commit Messages" and suggested following https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716 .
If this is requirement for MRs, we should consider:
The text was updated successfully, but these errors were encountered: