Skip to content

Branch naming guidelines in CONTRIBUTING.md are illegal #474

@soteri-scottmmjackson

Description

@soteri-scottmmjackson

Colons and spaces are not allowed in git branch names. Therefore the mandated branch naming convention is incoherent.


Branch Naming Convention

Every branch must follow one of these prefixes to identify the level of change:

Prefix Semver Impact When to Use
fix(scope): ... Patch Bug fixes, corrections, minor adjustments
feat(scope): ... Minor New features, new filters, new command support
chore(scope): ... Major Breaking changes, API changes, removed functionality

The scope in parentheses indicates which part of the project is concerned (e.g. git, kubectl, filter, tracking, config).

Branch title must clearly describe what is affected and the goal.

Examples:

fix(git): log-filter-drops-merge-commits
feat(kubectl): add-pod-list-filter
chore(proxy): remove-deprecated-flags

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions