chore(docs): Add commit, issue & PR guidelines #6022
Conversation
mydea
requested review from
Lms24 and
lobsterkatie
and removed request for
a team
mydea
force-pushed
the
fn/contribution-docs
branch
from
368df53 to
d59daf2
Compare
| <type>(<scope>): <subject> (<github-id>) | ||
| ```` | ||
|
|
||
| For example: `feat(core): Set custom transaction source for event processors (#5722)`. |
There was a problem hiding this comment.
l: Should we point out that this format only strictly has to apply to the squashed commit that we merge into master?
Asking because what I'm usually doing is that in the first commit of my branch, I use the <type>(<scope>): <subject> format but without any github id. For follow-up commits I usually don't stick strictly to the convention. Not saying that this is the best way to go but IMO, since we squash and get the chance to rewrite the message before merging, this is the only message that actually matters if that makes sense...
There was a problem hiding this comment.
Yeah, good point, I also thought about this a bit.
Maybe add a part like:
The Github-ID can be left out until the PR is merged
Does that make sense?
Update `CONTRIBUTING.md` to include some guidelines on writing commits, using issues and PRs.
mydea
force-pushed
the
fn/contribution-docs
branch
from
d59daf2 to
c4e822e
Compare
Update
CONTRIBUTING.mdto include some guidelines on writing commits, using issues and PRs.Rendered