Skip to content
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

Open
tyler36 opened this issue Apr 23, 2024 · 6 comments
Open

feat: add contribution guide #29

tyler36 opened this issue Apr 23, 2024 · 6 comments
Assignees

Comments

@tyler36
Copy link
Contributor

tyler36 commented Apr 23, 2024

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:

  • documenting this in the README
  • adding a contribution file outlining this (and other) requirements
  • adding a workflow that validates commit messages (DDEV does for MR messages, not sure about individual commits within)
@rfay
Copy link
Member

rfay commented Apr 23, 2024

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.

@seebeen
Copy link
Collaborator

seebeen commented Apr 23, 2024

I'll write the contrib guide. Regarding the config.

Squashing is OK.
Using PR titles for commits - not so much. IMHO, PR titles should be descriptive and human readable.

PR Title: Done this and this for this and this
commit msg: fix: Sorted docker compose file

Fixes #36

Feel free to reconfigure the repo for squash commits @rfay - don't have much experience with that 😅

@seebeen
Copy link
Collaborator

seebeen commented Apr 23, 2024

  • adding a workflow that validates commit messages (DDEV does for MR messages, not sure about individual commits within)

Generally speaking - Commit msg validation workflow is a bit overkill. Husky + commitizen can (and should) be used to enforce commits with hooks.

  • documenting this in the README
  • adding a contribution file outlining this (and other) requirements

Will make a contributing.md and set everything up.

@rfay
Copy link
Member

rfay commented Apr 23, 2024

I changed it to squash commits:

image

@rfay
Copy link
Member

rfay commented Apr 23, 2024

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:

image

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

@seebeen
Copy link
Collaborator

seebeen commented Apr 24, 2024

You're becoming my favourite person on GH 😊😊😊

@seebeen seebeen self-assigned this Apr 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants