Naming Convention Guidelines
Standardized naming conventions for better collaboration and organization
Following these conventions helps in better collaboration and understanding across the team.
Branch Naming Convention
When creating a new branch for documentation or bug fixes, use the following format:
Documentation Branches
Format: docs-<short-description>
Example: docs-update-api-reference
Bug Fix Branches
Format: bug-<short-description>
Example: bug-header-overflow
Use hyphens (-) to separate words in branch names. Avoid using spaces or underscores.
Pull Request Naming Convention
When submitting a pull request, follow the format below, depending on the type of PR:
Documentation Pull Requests
Format: [docs](<label>): <description>
Example: [docs](React): Updated React theory concept
Bug Fix Pull Requests
Format: [bug](<label>): <description>
Example: [bug](ui): Fixed button hover issue in the header
Here <label> refers to the main section, such as the technology or page you're working on (e.g., React, React Component, Nodejs).
Always include a label to indicate the section or main page you are addressing in the Pull Request. Make the description short and informative.
Issue Naming Convention
When reporting issues, use concise titles that clearly describe the problem or suggestion:
Bug Reports
Format: [Bug]: <Short Description>
Example: [Bug]: Dropdown menu not closing on click outside
Feature Requests
Format: [Feature]: <Short Description>
Example: [Feature]: Add dark mode toggle
Documentation Issues
Format: [Docs]: <Short Description>
Example: [Docs]: Incorrect code example in React tutorial
Summary of Naming Conventions
| Type | Format | Example |
|---|---|---|
| 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 |
Remember, following these naming conventions helps in better collaboration and understanding across the team.
Consistent naming makes it easier to track changes, understand the purpose of branches and PRs, and maintain project organization.