[doc] Fix typo and formatting in CONTRIBUTING.md #11381
Conversation
# Objective
Issue: There is a typo in `CONTRIBUTING.md` ("then" used in place of "them"). There is also an inconsistency of usage of periods at ends of items in lists, and one section is written with non-breaking spaces without good reason.
## Solution
Fix the aforementioned typo and consistency issues.
|
Welcome, new contributor! Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨ |
|
Whoops, forgot to mention making items of the first list in the document start with an uppercase letter, and removal of one probably insignificant newline and two trailing spaces at the end of one line. Usage of newlines seems sporadic in the document in general, but I felt it would make this a bit more annoying of a commit to deal with, and so decided to not do anything with that lol |
mockersf
added
C-Docs
| * A: Area (e.g. A-Animation, A-ECS, A-Rendering). | ||
| * C: Category (e.g. C-Breaking-Change, C-Code-Quality, C-Docs). | ||
| * D: Difficulty (e.g. D-Complex, D-Good-First-Issue). | ||
| * O: Operating System (e.g. O-Linux, O-Web, O-Windows). | ||
| * P: Priority (e.g. P-Critical, P-High). | ||
| * S: Status (e.g. S-Blocked, S-Controversial, S-Needs-Design). |
There was a problem hiding this comment.
I wouldn't use periods here. Bulleted list items should generally use periods if they either contain a full sentence or complete the introductory stem sentence (the sentence before ":"), which is not the case here. Stylistically, ")." also doesn't look as clean in my opinion.
| * How controversial are the design decisions. | ||
| * How complex is the implementation. |
There was a problem hiding this comment.
These are questions, so if we want punctuation here, the sentences should end with a question mark.
There was a problem hiding this comment.
Or rephrase as e.g. How complex the implementation is.
|
Oop- I'd have fixed the above too, but was asleep. Ah well, at least I hope I made somewhat of an improvement lol |
Objective
Issue: There is a typo in
CONTRIBUTING.md("then" used in place of "them"). There is also an inconsistency of usage of periods at ends of items in lists, and one section is written with non-breaking spaces without good reason.Solution
Fix the aforementioned typo and consistency issues.