AcademySoftwareFoundation / AcademySoftwareFoundation/rez
enforce a branch naming convention
- Dominant language
- Python
- Stars
- 1.1k
- Forks
- 374
- Avg merge
- 9d 12h
- Merged PRs (30d)
- 5
Description
Add a gh workflow to enforce the following branch name syntax:
```
[feat|bug|doc]/[issue-num]-{short_descr_with_underscores}
eg
feat/1234-add_the_thing
bug/1234-empty_pkgfam
doc/1234-add_pkgtesting_page
```
The action would also check that the issue number refers to an existing and open issue.
Contributor guide
Research direction
Use a GitHub Actions workflow as the entry point and first check how workflows are organized in the repository. The completed workflow should enforce the feat/bug/doc branch format, require a numeric issue reference with an underscored short description, and verify that the referenced issue exists and is open.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- ci-cd
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100