bratislava / bratislava.github.io

Our docs pages made in Nextra

https://bratislava.github.io

MIT License

2 stars 1 forks source link

Git Workflow changes proposal #53

Open radoslavzeman opened 4 months ago

radoslavzeman commented 4 months ago

Suggestions

Some suggestions to change regarding to https://namingconvention.org/git/ and our docs https://bratislava.github.io/onboarding/git-workflow#commit-message-branch-and-pr-name-formats

(Following format is not relevant, only the content)

Branch naming

Must:

Include a short descriptive summary in imperative present tense
Use Hyphens for separating words
Use only small letters
Include corresponding issue id if exists (from GitHub issue, Jira, etc.)

Should not:

Include the work type: feature, refactor, bugfix, hotfix, feat, fix, etc.
Include author's name or initials
Use big letters
Use slashes or backslashes

Suggested Format:

{2-3 word summary}-#{issue id}

Example:

git checkout -b oauth-migration-#244

Commit Message

Should

Follow Naming and Subject recommendations from https://namingconvention.org/git/commit-message-naming.html

Should not:

Use Conventional Commits

PR Naming

Must:

Follow https://namingconvention.org/git/pull-request-naming.html