From 39777ded54efa94dd78896c50b212ffcbadad7da Mon Sep 17 00:00:00 2001 From: Colin Walters Date: Wed, 30 Mar 2016 09:19:38 -0400 Subject: [PATCH] docs/CONTRIBUTING.md: Update for github move, Homu etc. Closes: #230 Approved by: jlebon --- docs/CONTRIBUTING.md | 47 ++++++++++++++++++++++++++++++-------------- 1 file changed, 32 insertions(+), 15 deletions(-) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 397ffeb0..a26f3975 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -1,29 +1,46 @@ Submitting patches ------------------ -You can: +A majority of current maintainers prefer the Github pull request +model, and this motivated moving the primary git repository to +. + +However, we do not use the "Merge pull request" button, because we do +not like merge commits for one-patch pull requests, among other +reasons. See [this issue](https://github.com/isaacs/github/issues/2) +for more information. Instead, we use an instance of +[Homu](https://github.com/servo/homu), currently known as +`cgwalters-bot`. + +As a review proceeeds, the preferred method is to push `fixup!` +commits via `git commit --fixup`. Homu knows how to use +`--autosquash` when performing the final merge. See the +[Git documentation](https://git-scm.com/docs/git-rebase]) for more +information. + +Alternative methods if you don't like Github (also fully supported): 1. Send mail to , with the patch attached - 1. Submit a pull request against 1. Attach them to -Please look at `git log` and match the commit log style. +It is likely however once a patch is ready to apply a maintainer +will push it to a github PR, and merge via Homu. + +Commit message style +-------------------- + +Please look at `git log` and match the commit log style, which is very +similar to the +[Linux kernel](https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git). + +You may use `Signed-off-by`, but we're not requiring it. Running the test suite ---------------------- -Currently, OSTree uses - -To run just OSTree's tests: - - ./configure ... --enable-installed-tests - gnome-desktop-testing-runner -p 0 ostree/ - -Also, there is a regular: - - make check - -That runs a different set of tests. +OSTree uses both `make check` and supports the +[Installed Tests](https://wiki.gnome.org/GnomeGoals/InstalledTests) +model as well (if `--enable-installed-tests` is provided). Coding style ------------