Skip to content

Commit c06ed0c

Browse files
authored
Fix/issue 901 branch naming (#1147)
* docs: Clarify branch naming convention * docs: Renumber Pull Request Process
1 parent d80e7c8 commit c06ed0c

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

contributing.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,20 @@ Include a clear title, description, and why the feature would be useful.
102102

103103
1. Create a new branch for your work:
104104
```bash
105-
git checkout -b feature/your-feature-name
105+
git checkout -b <label>/<github-username>/<issue-number>-<short-description>
106106
```
107107

108+
Example:
109+
```bash
110+
git checkout -b documentation/msgem0523/901-add-contributing-guidelines
111+
```
112+
113+
Where:
114+
- **`label`** = the issue label/category (see [Allowed Types](#allowed-types))
115+
- **`github-username`** = your GitHub username
116+
- **`issue-number`** = the GitHub issue number
117+
- **`short-description`** = a brief description of the work being completed
118+
108119
2. Make your changes
109120
When making changes:
110121
- Follow the existing project structure

0 commit comments

Comments
 (0)