- Notifications
You must be signed in to change notification settings - Fork383
Contributing
Contributing to the SELinux userspace project is a similar process toother open source projects. Bug reports, new features to the existingcode, additional tools, or updated documentation are all welcome.Before undertaking a new task, it is a good idea to first post to theselinux@vger.kernel.org mailing list to see if anyone else is already working on it.
You can find a list of open issues to the SELinux userspace code athttps://github.com/SELinuxProject/selinux/issues
See the SELinux kernelGetting Started guide if you want to contribute to SELinux kernel development instead.
SELinux has a public mailing list for developers, subscribe by sending an email toselinux+subscribe@vger.kernel.org. It is generally wise to read relevant postings to the list before beginning any area of new work. Searchable mailing list archives are available externally athttps://lore.kernel.org/selinux/ . Patches for SELinux are tracked viahttps://patchwork.kernel.org/project/selinux/list/ .
An unofficial SELinux IRC channel is#selinux onLibera.Chat .
All bugs and patches should be submitted to theSELinux mailinglist atselinux@vger.kernel.org.
When reporting bugs please include versions of SELinux related libraries andtools (libsepol, libselinux, libsemanage, checkpolicy). If you areusing a custom policy please include it as well.
There are a number of dependencies required to build the userspacetools/libraries. Consult theREADME.mdfor the current list of dependencies and how to build the userspace code.
After cloning the code of the repository (see below), create a patchagainst the repository, and post that patch to theSELinux mailinglist atselinux@vger.kernel.org. When preparingpatches, please follow these guidelines:
- Patches should apply with git am
- Must apply against HEAD of the main branch
- Separate large patches into logical patches
When adding new, large features or tools it is best to discuss thedesign on the mailing list prior to submitting the patch.
Seegit-send-email andsubmitting-patches for how to configure git-send-email for sending patches inline within email messages as required by the SELinux maintainers.
You will send the patch via git send-email to theselinux@vger.kernel.org mailing list. The command below is for sending the topmost patch from your repository; if you need to send more than one patch or you are sending a patch from a file instead, you will need to adjust the command line accordingly.
git send-email --subject-prefix="PATCH userspace" -1 --to=selinux@vger.kernel.org- Consider installing and usingb4 for verifying and applying patches.
- Usepatchwork for tracking patches, updating the state of each patch to reflect where it is in the workflow.
To get a copy of the SELinux userland repository you canrun:
$ git clone https://github.com/SELinuxProject/selinux