From 733d35bdfd8fe57caa84b5146ba01108b405c3c8 Mon Sep 17 00:00:00 2001 From: Jeremy Cline Date: Wed, 11 Mar 2020 15:32:58 +0000 Subject: [PATCH] Update Contributor Guide --- Contributor-Guide.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/Contributor-Guide.md b/Contributor-Guide.md index 0321343..cea43d5 100644 --- a/Contributor-Guide.md +++ b/Contributor-Guide.md @@ -4,19 +4,27 @@ These guides assume you've completed the [setup guide](https://gitlab.com/cki-pr There are two major types of contributions ARK accepts. The first is kernel configuration options and build scripts, both of which live in the ``internal`` branch. The second are patches to the kernel itself, which are in ``ark-patches``. -## Configuration +## Configuration, Build Scripts, and Specfile -To change the kernel configuration used for ARK, start a new branch based on ``internal``: +Start a new branch based on ``internal``: 1. ``git fetch upstream`` -2. ``git checkout -b my-config-change upstream/internal`` -3. Make a change to the configuration in ``redhat/configs/{ark,common,fedora}}``. Configuration in ``common`` apply to both Fedora and ARK kernels. Options in ``ark`` override any options in ``common`` and apply only to ARK kernels. Options in ``fedora`` override any options in ``common`` and apply only to Fedora. +2. ``git checkout -b my-build-change upstream/internal`` +3. Make a change to a file or files in ``redhat/``. 4. Add your changes with ``git add -A``. 5. Commit your changes and write a nice commit message that explains the change: ``git commit -s``. -6. Open a merge request: ``git push -o merge_request.create -o merge_request.target=internal -o merge_request.remove_source_branch -u my-config-change`` +6. Open a merge request: ``git push -o merge_request.create -o merge_request.target=internal -o merge_request.remove_source_branch -u my-build-change`` +## Fedora Kernel Patches -## Kernel Patches +To add or update a kernel patch carried for Fedora, start a new branch based on ``fedora-patches``: + +1. ``git fetch upstream`` +2. ``git checkout -b my-kernel-patch upstream/fedora-patches`` +3. Add any commits you like. +4. Open a merge request against ``fedora-patches``: ``git push -o merge_request.create -o merge_request.target=fedora-patches merge_request.remove_source_branch -u my-kernel-patch`` + +## ARK Kernel Patches To add or update a kernel patch carried for ARK, start a new branch based on ``ark-patches``: