docs: Add documentation for releases and commit style #5675
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bpmct
approved these changes
Jan 12, 2023
mtojek
reviewed
Jan 12, 2023
| - Good: `feat(api): Add feature X` | ||
| - Bad: `feat(api): Added feature X` (past tense) | ||
|
|
||
| A good rule of thumb for writing good commit messages is to recite: [If applied, this commit will ...](https://reflectoring.io/meaningful-commit-messages/). |
There was a problem hiding this comment.
When I merge PRs, I make sure that the first line of commit message is aligned with the convention. Should I also pay attention to other lines? For instance:
commit d9436fab69203740a25c29f2d27146bb04bc14c3 (upstream/main, main)
Author: Marcin Tojek <mtojek@users.noreply.github.com>
Date: Wed Jan 11 16:05:42 2023 +0100
docs: API enterprise (#5625)
* docs: audit, deploymentconfig, files, parameters
* Swagger comments in workspacebuilds.go
* structs in workspacebuilds.go
* workspaceagents: instance identity
* workspaceagents.go in progress
* workspaceagents.go in progress
* Agents
* workspacebuilds.go
...
I know that this can really long.
There was a problem hiding this comment.
Great question. I haven’t given it much thought to what it should look like.
Personally I usually either remove the bullets entirely, rewrite it as proper paragraphs (max width 72) or only keep/rewrite certain relevant bullet points.
Using the type/prefix is not necessary for these IMO. But it’s also not a crime to use them 😄
mtojek
approved these changes
Jan 13, 2023
989ac12 to
1d64aaf
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds documentation to
CONTRIBUTING.mdfor creating releases and how to write commits.It also improves the
--helpofrelease.sh.Fixes #5233
Fixes #5380