Skip to main content

Git Conventions

Conventional Commits

See: Conventional Commits

Branching

Fix/Issue

The naming conventions for branches in open-source software (OSS) projects can vary, but a common convention for naming a branch that addresses a specific issue involves including the issue number for easy traceability. Here's a general format you can follow:

fix/issue-<issue-number>-<short-description>

For issue #2, your branch name could be:

fix/issue-2-ci-build-without-configuration

This format helps identify the branch's purpose and links it to the corresponding issue, providing better context within the repository. Make sure to check any existing contributing guidelines for the specific repository you're working on, as they may have their own conventions or preferences.