Skip to content

submit_patch

Jan Boon edited this page Mar 14, 2022 · 14 revisions

title: How to submit a patch description: published: true date: 2022-03-14T10:50:54.740Z tags: editor: markdown dateCreated: 2022-03-14T10:41:29.429Z

Formatting

Any newly written code should follow the coding conventions. However, as not all existing code follows these strictly yet, small patches may opt to follow the existing style of surrounding code to maintain readability.

Do not hide your changes in a giant auto-formatting commit. If you do this your PR will be rejected, and commits will be reverted. Any commits that reformat a file, or mass-rename variables, must be separate, not hide any changes, follow the coding conventions, and not negatively affect the readability of the code.

Here's a real example of a very bad commit. As you can see, it becomes very difficult to review and accept such patches when the changes are hidden in unnecessary auto-formatting noise.

format_bomb_hiding.png {.is-warning}

Clone this wiki locally