Skip to content

Commit d54dcb3

Browse files
bachradsusistephensmalley
authored andcommitted
Update CONTRIBUTING.md
This is based on https://github.com/SELinuxProject/selinux/wiki/Contributing with preserved "Developer Certificate of Origin" part Signed-off-by: Petr Lautrbach <[email protected]> Acked-by: Stephen Smalley <[email protected]>
1 parent 919e9e6 commit d54dcb3

File tree

1 file changed

+32
-19
lines changed

1 file changed

+32
-19
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,36 +4,52 @@ Contributing to the SELinux userspace project is a similar process to
44
other open source projects. Bug reports, new features to the existing
55
code, additional tools, or updated documentation are all welcome.
66

7-
You can find a list of open issues where you might contribute to the SELinux kernel code at
8-
https://github.com/SELinuxProject/selinux-kernel/issues or to the SELinux userspace code at
9-
https://github.com/SELinuxProject/selinux/issues.
7+
You can find a list of open issues to the SELinux userspace code at
8+
https://github.com/SELinuxProject/selinux/issues
109

11-
See the SELinux userspace
12-
[wiki page](https://github.com/selinuxproject/selinux/wiki) for more
13-
information on mailing lists, documentation, and other resources.
10+
See the SELinux kernel [Getting Started](https://github.com/selinuxproject/selinux-kernel/wiki/Getting-Started)
11+
guide if you want to contribute to SELinux kernel development instead.
12+
13+
## Mailing list
14+
15+
SELinux has a public mailing list for developers, subscribe by sending an email to
16+
17+
It is generally wise to read relevant postings to the list before beginning any
18+
area of new work. Searchable mailing list archives are available externally at
19+
https://lore.kernel.org/selinux/ . Patches for SELinux are tracked via
20+
https://patchwork.kernel.org/project/selinux/list/ .
21+
22+
## IRC
23+
24+
An unofficial SELinux IRC channel is
25+
[\#selinux](https://web.libera.chat/?channel=#selinux) on [Libera.Chat](https://libera.chat/).
1426

1527
## Reporting Bugs
1628

17-
All bugs and patches should be submitted to the [SELinux mailing
18-
list](https://lore.kernel.org/selinux) at [email protected].
29+
All bugs and patches should be submitted to the
30+
[SELinux mailing list](https://lore.kernel.org/selinux) at
31+
1932

2033
When reporting bugs please include versions of SELinux related libraries and
2134
tools (libsepol, libselinux, libsemanage, checkpolicy). If you are
2235
using a custom policy please include it as well.
2336

2437
## Compiling
2538

26-
See README.md for instructions on how to compile and test this project.
39+
There are a number of dependencies required to build the userspace
40+
tools/libraries. Consult the [README.md](https://github.com/SELinuxProject/selinux/blob/main/README.md)
41+
for the current list of dependencies and how to build the userspace code.
2742

2843
## Contributing Code
2944

30-
After obtaining the code of the repository (see below), create a patch
31-
against the repository, and post that patch to the [SELinux mailing
32-
list](https://lore.kernel.org/selinux) at [email protected]. When preparing
33-
patches, please follow these guidelines:
45+
After cloning the code of the repository (see below), create a patch against the
46+
repository, and post that patch to the
47+
[SELinux mailing list](https://lore.kernel.org/selinux) at
48+
49+
When preparing patches, please follow these guidelines:
3450

35-
- Patches should apply with -p1
36-
- Must apply against HEAD of the master branch
51+
- Patches should apply with git am
52+
- Must apply against HEAD of the main branch
3753
- Separate large patches into logical patches
3854
- Patch descriptions must end with your "Signed-off-by" line. This means your
3955
code meets the Developer's certificate of origin, see below.
@@ -43,10 +59,7 @@ design on the mailing list prior to submitting the patch.
4359

4460
## Development Repository
4561

46-
Git is a modern source code management system. For more information
47-
about Git please see the Git website.
48-
49-
To get an anonymous checkout of the SELinux userland repository you can
62+
To get a copy of the SELinux userland repository you can
5063
run:
5164

5265
$ git clone https://github.com/SELinuxProject/selinux.git

0 commit comments

Comments
 (0)