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

Update Contributor Guide

Jeremy Cline 2020-03-20 17:39:17 +00:00
parent 0b198f2fff
commit 16789b7a98
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
Contributor-Guide.md

@ -48,9 +48,25 @@ To add or update a kernel patch carried for ARK, start a new branch based on ``a
1. `git fetch upstream`
2. `git checkout -b my-kernel-patch upstream/ark-patches`
3. Add any commits you like. These patches should already be submitted upstream and should, ideally, already be accepted in at least a sub-system maintainer's tree.
3. Add commits any way you'd like (`git am`, `git cherry-pick -x`, etc). Patches are not likely to be excepted if they're not already on their way upstream.
4. Open a merge request against ``ark-patches``: ``git push -o merge_request.create -o merge_request.target=ark-patches merge_request.remove_source_branch -u <your-remote> my-kernel-patch``
### Commit messages
Kernel patches should be submitted upstream prior to being sent for inclusion in Fedora. The commit message for the patch should be the same as upstream, except for the addition of one tag in the message. Each commit should contain an `Upstream Status` tag to indicate where the patch can be found. Some examples:
A patch that's been sent upstream, but is not yet in a sub-maintainer's tree should link to the email:
Upstream Status: https://lore.kernel.org/lkml/20200220151738.1492852-1-jcline@redhat.com/
A patch that's been accepted into an upstream maintainer's tree should reference the tree and should also include the upstream commit in the format used by `git cherry-pick -x`:
Upstream Status: git://git.kernel.org/pub/scm/linux/kernel/git/netdev/net-next.git
Finally, a downstream-only patch :
Upstream Status: RHEL only
## Licensing