davidlt/kernel-ark
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update Contributor Guide

Jeremy Cline 2020-03-11 15:32:58 +00:00
parent 6fee0a288e
commit 733d35bdfd
1 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
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 <your-remote> 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 <your-remote> 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 <your-remote> my-kernel-patch``
## ARK Kernel Patches
To add or update a kernel patch carried for ARK, start a new branch based on ``ark-patches``: