Closed patricknelson closed 6 months ago
Yep, this is a must. Thank you for raising it.
For a long time makeup was mostly a one man show, it's only fairly recently we've had additional collaborators. For the most part I can pull over the guidelines from skin and coreui. I'd like to keep it consistent with how we operate there.
I made some quick additions to cover the main points above. I will be refining as I go...
Squash any non-atomic local commits (e.g. any "work in progress" type commits) before pushing up your PR
Please manually follow commitlint format for commit messages. We shall be integrating this tool soon for automatic linting of commit messages.
I've never heard of that before (always something to learn). But clicking that took me to a tool where it wasn't immediately clear what the commit message syntax should be. Is there a more direct link with instructions on what the message format should be? My 2min dive into their reference was a rabbit hole of unrelated configuration when the goal here is simply understanding what's desired for this project. Ideally it's just a simple set of guidelines so you don't get bogged down and then more details can be found by going into the tool itself maybe?
Oops, yes bad link. I will fix it as part of https://github.com/makeup/makeup-js/issues/161
Ok cool 😅 just for my future reference, where should it be linking to?
To here: https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional
I should have just copied this format: https://github.com/eBay/skin/blob/master/CONTRIBUTING.md#commit-message-format
Would love really quick to have some quick guidelines documented explaining various things, like:
And potentially anything else I may have missed (this was just off the top of the head).
Edit: Can potentially roll these things into https://github.com/makeup/makeup-js/blob/master/CONTRIBUTING.md