For Developers: Submitting Patches

Submitting and review

A patchset that is suitable for merging has to meet a number of formal requirements:

• it must be a submitted as a Pull Request on Github
• each commit must be signed off
• each commit must have a single-line subject (less than 72 characters)
• each commit must have a meaningful commit message
• If applicable, the driver must pass make check

You can submit a Pull Request for review and merging if the patchset meets these requirements. Below is more information on some of these points.

Pull Requests

For information on making a pull request please see https://help.github.com/en/articles/about-pull-requests

Review Process

Once submitted, it may take several days until someone reviews it. In the best case, your patch will be accepted without changes. Many patches however need to be re-done before they are merged. Don't take it badly, even the maintainers of the driver regularly re-do the patches after review. The main goal is to have an easy to understand, bug-free, maintainable codebase.

If you have to re-submit a patch, please state that this is a new version of a previous patch and list the differences to the previous version so reviewers can concentrate on that. The best space for this is after the '''--''' in the patch file. The part there is automatically removed when applying the patch. And example is

[PATCH v2] the meaningful subject line

most likely same summary as before but may be extended or changed. either way,
still a useful summary.

Signed-off-by: Wile E. Coyote <customer-no-1@acme.com>
---

Changes to previous version:
- fixed spelling of typo
- changed the world, is now flat again
- removed universe, world is center now

  geography/world.c                     | 5000 ++++---
  geography/universe.c                  | 5000 -------

[...]