dusk-network / dusk-network/.github
CONTRIBUTING.md gives advice on branch name that is invalid for Git
@autholykos is already working on this.
Since Oct 31, 2023.
- Dominant language
- No language data
- Stars
- 2
- Forks
- 3
- Avg merge
- 19m
- Merged PRs (30d)
- 1
Description
Describe the bug
In the CONTRIBUTING.md file, there is advise to create a branch named something like feature-[issue_nr]. However, if you try to make a branch using that format (or even that exact example), then you get an error: fatal: 'feature-[issue_nr]' is not a valid branch name..
To Reproduce
- Clone any repo
- Checkout a new branch (
git checkout -b feature-[issue_nr])
Expected behaviour
The CONTRIBUTING.md file should give valid examples for developers to follow, such that questions over conventions are made irrelevant.
Logs/Screenshot
$ git checkout -b feature-[issue_nr] ⬡ 18.12.0 [±main ✓]
fatal: 'feature-[issue_nr]' is not a valid branch name.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.