shaba/ostree
1
0
Fork 0
mirror of https://github.com/ostreedev/ostree.git synced 2025-03-21 02:50:37 +03:00
Code Issues Projects Releases Wiki Activity

docs/CONTRIBUTING.md: Update for github move, Homu etc.

Browse Source 
Closes: #230
Approved by: jlebon
This commit is contained in:
Colin Walters 2016-03-30 09:19:38 -04:00 committed by Colin Walters (automation)
parent 9260d3dba1
commit 39777ded54
1 changed files with 32 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/CONTRIBUTING.md
View File

@ -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
<https://github.com/ostreedev/ostree>.
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 <ostree-list@gnome.org>, with the patch attached
1. Submit a pull request against <https://github.com/GNOME/ostree>
1. Attach them to <https://bugzilla.gnome.org/>
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 <https://wiki.gnome.org/GnomeGoals/InstalledTests>
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
------------