Closed lennartkloock closed 8 months ago
The slash in parenthesis of the commit message is for sure not to format. Please choose one or remove the parenthesis entirely if the scope is global.
The slash in parenthesis of the commit message is for sure not to format. Please choose one or remove the parenthesis entirely if the scope is global.
Because this is a mono repo the scope is not global most of the time. What scope would you suggest for platform/website
or platform/api
?
Edit: I can't just write api
because we have a video api and a platform api. And I can't just write platform
because we have platform website and platform api
@lennartkloock Hmm, I've googled around a bit and it looks like dashes are generally uhhh ok, probably.
Conventional Commits is strongly against anything but a single word:
A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g.,
fix(parser):
Karma Style is indifferent:
Example
<scope>
values:
web-server
I personally like the slash, it clearly conveys the intent - "part of" or a "subdirectory", instead of just "component name". A dash is a compromise I'm willing to accept (e.g. platform-api
).
On a related note, I think the prefix of the commit message is getting too long with that subject name ij general. Maybe we should name the components somehow and use that shorter name? How about shortening website
to web
? Not much help though... Still, shorter is better in this case IMO.
I just noticed the image_processor
commits. Not sure how I feel about that underscore... Probably negatively. If those will be squashed anyway then it doesn't matter much.
@IS2511 I'll just leave out platform/
or video/
in the future. I guess that's enough because apart from api all components have unique names anyway
Attention: 277 lines
in your changes are missing coverage. Please review.
Comparison is base (
cf18151
) 46.71% compared to head (420707a
) 46.44%.
Proposed changes
This pr implements website support for profile pictures.
Including:
Types of changes
What types of changes does your code introduce to Scuffle? Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.Further comments