Skip to content
OpenPrep

Naming Conventions

Branch Naming Convention

When creating a new branch for documentation or bug fixes, use the following format:

  1. Documentation Branches
    Format: docs-<short-description>
    Example: docs-update-api-reference

  2. Bug Fix Branches
    Format: bug-<short-description>
    Example: bug-header-overflow

Pull Request Naming Convention

When submitting a pull request, follow the format below, depending on the type of PR:

  1. Documentation Pull Requests
    Format: [docs](<label>): <description>
    Example: [docs](React): Updated React theory concept

  2. Bug Fix Pull Requests
    Format: [bug](<label>): <description>
    Example: [bug](ui): Fixed button hover issue in the header

Issue Naming Convention

When reporting issues, use concise titles that clearly describe the problem or suggestion:

  1. Bug Reports
    Format: [Bug]: <Short Description>
    Example: [Bug]: Dropdown menu not closing on click outside

  2. Feature Requests
    Format: [Feature]: <Short Description>
    Example: [Feature]: Add dark mode toggle

  3. Documentation Issues
    Format: [Docs]: <Short Description>
    Example: [Docs]: Incorrect code example in React tutorial

Summary of Naming Conventions

TypeFormatExample
Branch (Docs)docs-<short-description>docs-update-api-reference
Branch (Bug Fix)bug-<short-description>bug-header-overflow
Pull Request (Docs)[docs](<label>): <description>[docs](React): Updated React component
Pull Request (Bug Fix)[bug](<label>): <description>[bug](ui): Fixed button hover issue
Issue (Bug Report)[Bug]: <Short Description>[Bug]: Dropdown menu not closing
Issue (Feature Request)[Feature]: <Short Description>[Feature]: Add dark mode toggle
Issue (Docs)[Docs]: <Short Description>[Docs]: Incorrect code example in docs