Name branches

How to name branches

• For pull requests
• For release branches
• Reserved for documentation

For pull requests

Use the following pattern:

USER/TYPE/NAME
USER/TYPE/SCOPE/NAME

• USER: Your GitHub username.
• TYPE: Any of the following:
  • fixes:
    • Changes that patches a bug in the codebase.
    • Changes that improves performance.
    • Changes to Documentation.
    • Changes that do not affect the meaning of the code.
    • Changes to tests.
  • features:
    • A new feature to the codebase.
    • A refactor which neither fixes a bug nor adds a feature.
  • chores:
    • Changes that affect the build system.
    • Changes to the CI configuration files and scripts.
• SCOPE: The specific part of the project.
• NAME: A descriptive name explaining the change. Use dashes to separate words. All letters must be lowercase. Prefer the Basic Latin characters.

Sources

• Conventional Commits
• Angular commit messages

For release branches

Use the following pattern:

releases/MAJOR

• MAJOR: The major part of the version in package.json.

Reserved for documentation

The documentation CI reserves, creates, and manages the following branches:

• docs: Markdown documentation files.
• gh-pages: GitHub Pages website files.