Skip to content

Commit

Permalink
docs: specify allowed character set for branch names
Browse files Browse the repository at this point in the history
As specified by docker tags requirements [1] and `docker-metadata` [2].
Prevents issues like [3] on parenthesis (not actually related to tag
name, but to Docker failing CI configuration).

[1]: https://docs.docker.com/reference/cli/docker/image/tag/#description
[2]: https://github.com/docker/metadata-action?tab=readme-ov-file#image-name-and-tag-sanitization
[3]: https://github.com/stacks-network/stacks-core/actions/runs/9766520161/job/27087431713?pr=4921
  • Loading branch information
aldur committed Jul 8, 2024
1 parent 162675c commit f63fd95
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f63fd95

Please sign in to comment.