From f72ea38423a9cac04c1a39c7a370a520c9fd6a3f Mon Sep 17 00:00:00 2001 From: Luan Nico Date: Sun, 28 Sep 2025 18:11:21 -0700 Subject: [PATCH] docs: Enhance language on CONTRIBUTING.md (#3732) Enhance language on `CONTRIBUTING.md` --- CONTRIBUTING.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9b25edde1..4edbcf640 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ please read these instructions carefully. - You can also join us on [Discord] to discuss some initials thoughts. - If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending too much time writing the code. In some cases, enhancements may not align well - with the project future development direction. + with the project's future development direction. - Implement the code for the new feature and please read the [How To](#how-to-contribute). @@ -185,6 +185,10 @@ Allowed types are: If you introduce a **breaking change** the conventional commit type MUST end with an exclamation mark (e.g. `feat!: Remove the position argument from PositionComponent`). +The sentence of the commit (after the `:`) should start with a verb in the present tense; as a rule +of thumb, think that the commit message will complete the sentence "This commit will ...". +For example, "Add support for ..." or "Fix bug with ...". + Examples of PR titles: - feat: Component.childrenFactory can be used to set up a global ComponentSet factory