diff options
| author | Simon Ser <contact@emersion.fr> | 2021-08-30 15:20:27 +0200 |
|---|---|---|
| committer | Simon Zeni <simon@bl4ckb0ne.ca> | 2021-08-30 10:29:33 -0400 |
| commit | 2ddd8e80364235001dcbbd5bd771d032c93dc9ad (patch) | |
| tree | 4af553493afad1accdc41761b3bec06fbf0dee2b | |
| parent | bfc69decdd04f3350135cf489655c4216c5889d1 (diff) | |
contributing: add new section about commit log
This is shamelessly stolen from Weston [1].
It's been a while we've transitioned away from merge commits and
work-style commit history, so it'd be nice to mention this in the
docs.
[1]: https://gitlab.freedesktop.org/wayland/weston/-/blob/main/CONTRIBUTING.md#formatting-and-separating-commits
| -rw-r--r-- | CONTRIBUTING.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 840398b0..1ef5ff0e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,6 +36,41 @@ your new features work correctly). Document all of the edge cases you're aware of so we can adequately test them - then verify the test plan yourself before submitting. +## Commit Log + +Unlike many projects using GitHub and GitLab, wlroots has a [linear, "recipe" +style](https://www.bitsnbites.eu/git-history-work-log-vs-recipe/) history. This +means that every commit should be small, digestible, stand-alone, and +functional. Rather than a purely chronological commit history like this: + +``` +doc: final docs for view transforms +fix tests when disabled, redo broken doc formatting +better transformed-view iteration (thanks Hannah!) +try to catch more cases in tests +tests: add new spline test +fix compilation on splines +doc: notes on reticulating splines +compositor: add spline reticulation for view transforms +``` + +We aim to have a clean history which only reflects the final state, broken up +into functional groupings: + +``` +compositor: add spline reticulation for view transforms +compositor: new iterator for view transforms +tests: add view-transform correctness tests +doc: fix formatting for view transforms +``` + +This ensures that the final patch series only contains the final state, +without the changes and missteps taken along the development process. A linear +history eases reviewing, cherry-picking and reverting changes. + +If you aren't comfortable with manipulating the Git history, have a look at +[git-rebase.io](https://git-rebase.io/). + ## Commit Messages Please strive to write good commit messages. Here's some guidelines to follow: |