selinux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Petr Lautrbach <plautrba@redhat.com>
To: selinux@vger.kernel.org
Cc: Petr Lautrbach <plautrba@redhat.com>
Subject: [PATCH] Add CONTRIBUTING
Date: Wed, 29 May 2019 18:03:37 +0200	[thread overview]
Message-ID: <20190529160337.4672-1-plautrba@redhat.com> (raw)

Based on https://github.com/SELinuxProject/selinux/wiki/Contributing

Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
---
 CONTRIBUTING | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)
 create mode 100644 CONTRIBUTING

diff --git a/CONTRIBUTING b/CONTRIBUTING
new file mode 100644
index 00000000..784d2023
--- /dev/null
+++ b/CONTRIBUTING
@@ -0,0 +1,60 @@
+# Contributing to SELinux
+
+Contributing to the SELinux userspace project is a similar process to
+other open source projects. Bug reports, new features to the existing
+code, additional tools, or updated documentation are all welcome.
+
+You can find a list of open issues where you might contribute to the SELinux kernel code at
+https://github.com/SELinuxProject/selinux-kernel/issues or to the SELinux userspace code at
+https://github.com/SELinuxProject/selinux/issues.
+
+See the selinuxproject.org http://selinuxproject.org/page/User_Resources page for more
+information on mailing lists, documentation, and other resources.
+
+## Reporting Bugs
+
+All bugs and patches should be submitted to the SELinux mailing
+list at selinux@vger.kernel.org - https://lore.kernel.org/selinux .
+
+When reporting bugs please include versions of SELinux related libraries and
+tools (libsepol, libselinux, libsemanage, checkpolicy). If you are
+using a custom policy please include it as well.
+
+## Compiling
+
+There are a number of dependencies required to build the userspace
+tools/libraries. On a Fedora system you can install them with yum:
+
+    # yum install audit-libs-devel bison bzip2-devel dbus-devel dbus-glib-devel flex flex-devel flex-static glib2-devel libcap-devel libcap-ng-devel pam-devel pcre-devel python3-devel python3-setools swig xmlto redhat-rpm-config
+
+
+The tools and libraries can be built and installed under a private directory from the top level with make, e.g.
+
+    $ make DESTDIR=~/obj install install-pywrap
+
+## Contributing Code
+
+After obtaining the code of the repository (see below), create a patch
+against the repository, and post that patch to the SELinux mailing
+list at selinux@vger.kernel.org - https://lore.kernel.org/selinux .
+When preparing patches, please follow these guidelines:
+
+-   Patches should apply with -p1
+-   Must apply against HEAD of the master branch
+-   Separate large patches into logical patches
+-   Patch descriptions must end with your "Signed-off-by" line.
+    This means your code meets the Developer's certificate of origin -
+    https://developercertificate.org/.
+
+When adding new, large features or tools it is best to discuss the
+design on the mailing list prior to submitting the patch.
+
+## Development Repository
+
+Git is a modern source code management system. For more information
+about Git please see the Git website.
+
+To get an anonymous checkout of the SELinux userland repository you can
+run:
+
+    $ git clone <https://github.com/SELinuxProject/selinux
-- 
2.22.0.rc1


             reply	other threads:[~2019-05-29 16:03 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-29 16:03 Petr Lautrbach [this message]
2019-05-29 16:05 ` [PATCH] Add CONTRIBUTING Paul Moore
2019-05-31 15:16   ` Paul Moore
2019-05-31 17:45     ` Petr Lautrbach
2019-05-31 17:54       ` Paul Moore
2019-05-31 20:19         ` [PATCH v2] Add CONTRIBUTING.md Petr Lautrbach
2019-05-31 21:01           ` Paul Moore
2019-06-14 19:00           ` Stephen Smalley

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190529160337.4672-1-plautrba@redhat.com \
    --to=plautrba@redhat.com \
    --cc=selinux@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).