docs: Update guides #15
Conversation
|
|
||
| ## Writing Commit Messages | ||
|
|
||
| Commit messages matter. Please have a look at [How to Write a Git Commit Message](https://cbea.ms/git-commit/) for a |
There was a problem hiding this comment.
To be discussed: https://www.conventionalcommits.org/en/v1.0.0/
There was a problem hiding this comment.
We as maintainers could just do that internally by squashing PRs into one commit and name that one commit accordingly.
This may be easier for possible contributors.
It could be easier to just ask contributors to name just the PR title accordingly, this way we can use the features provided by GitHub to do so with one click.
There are possibilities to validate PR titles against such conventions automatically with GitHub actions as well.
There was a problem hiding this comment.
I like the idea, contributions should definitely be as easy as possible.
I'm thinking wether we should simply require a PR title+description that make sense and do the (conventional) commit stuff ourselves/during merge. Only the original author can tell what their intention and thought process was, so this IMHO needs to come from them, but which prefixes to use is maybe more of an implementation detail.
There was a problem hiding this comment.
I like the idea to motivate contributors to name the title according to conventional commits.
IMO it would be optimal if the PR title would reflect the commit messages first line and the PR description the commit message body.
From a format and wording point of view.
Moves parts of the README to dedicated guides and extends guidance for contribution and security-related issues.
stuebingerb
force-pushed
the
feature/update-guides
branch
from
de958cc
to
f09ac62
Compare
Moves parts of the README to dedicated guides and extends guidance for contribution and security-related issues.