github / github/codeql

Add hyphenation rule to style guide

Open
#10,800 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
CodeQL
Stars
10.1k
Forks
2.1k
Avg merge
2d 15h
Merged PRs (30d)
141

Description

In https://github.com/github/codeql/pull/10743#discussion_r991097126, it seems that the preference of this project is to retain hyphens. As there is a style guide:
https://github.com/github/codeql/blob/c3af41b907a25034784bac2feacbf14bd66fad13/docs/qldoc-style-guide.md?plain=1#L19
It seems like there should be an entry in it to indicate the divergence from American English (which generally prefers to drop hyphens). It isn't as simple as "always keep hyphens", as [`e-mail` (13)](https://github.com/github/codeql/search?q=e-mail) is clearly dwarfed by [`email` (140)](https://github.com/github/codeql/search?q=email).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.