Use of '#' as first character in commit title can be construed as a comment in some environments
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 36
- Forks
- 11
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 25
Description
Regarding the contributing requirement:
I have noticed that certain environments, such as editing a commit in a text editor with 'git commit' or 'git commit --amend' instead of using the -m option to add the commit directly on the command line, result in the hash sign '#' being treated as a comment.
Perhaps consider an alternative mechanism to identify the issue number?
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.
Research direction
Start with CONTRIBUTING.md at the referenced section around line 48 and review how issue numbers are required in commit titles. Update the guidance so the issue identifier cannot be mistaken for a comment when editing commits in a text editor; done means the requirement is unambiguous for both command-line and editor-based commits.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 75/100