flutter/flame
1
0
Fork 0
mirror of https://github.com/flame-engine/flame.git synced 2025-11-04 04:47:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: Enhance language on CONTRIBUTING.md (#3732)

Browse Source 
Enhance language on `CONTRIBUTING.md`
This commit is contained in:
Luan Nico
2025-09-28 18:11:21 -07:00
committed by GitHub
parent 632bb6b722
commit f72ea38423
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
CONTRIBUTING.md
View File

@ -30,7 +30,7 @@ please read these instructions carefully.
- You can also join us on [Discord] to discuss some initials thoughts. - 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 - 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 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). - 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 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`). 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: Examples of PR titles:
- feat: Component.childrenFactory can be used to set up a global ComponentSet factory - feat: Component.childrenFactory can be used to set up a global ComponentSet factory