Merge pull request #4951 from aldur/docs/branch_name_symbols

docs: specify allowed character set for branch names
stacks-network · Jul 8, 2024 · b39bcec · b39bcec
2 parents e3c3903 + f63fd95
commit b39bcec
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -43,6 +43,11 @@ Branch names should use a prefix that conveys the overall goal of the branch:
 - `test/more-coverage` for branches that only add more tests
 - `refactor/formatting-fix` for refactors
 
+The branch suffix must only include ASCII lowercase and uppercase letters,
+digits, underscores, periods and dashes.
+
+The full branch name must be max 128 characters long.
+
 ### Merging PRs from Forks
 
 PRs from forks or opened by contributors without commit access require