[PATCH] Add CONTRIBUTING

[PATCH] Add CONTRIBUTING

[Petr Lautrbach]

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

Re: [PATCH] Add CONTRIBUTING

[Paul Moore]

On Wed, May 29, 2019 at 12:03 PM Petr Lautrbach <plautrba@redhat.com> wrote:
>
> 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

I would suggest updating the wiki to point to this file if/when it is
merged upstream.

-- 
paul moore
www.paul-moore.com

Re: [PATCH] Add CONTRIBUTING

[Paul Moore]

On Wed, May 29, 2019 at 12:05 PM Paul Moore <paul@paul-moore.com> wrote:
> On Wed, May 29, 2019 at 12:03 PM Petr Lautrbach <plautrba@redhat.com> wrote:
> >
> > 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
>
> I would suggest updating the wiki to point to this file if/when it is
> merged upstream.

Sorry, one more thing: you might consider adding the ".md" suffix so
that GitHub and others will treat it as Markdown.  I know that GitHub
also treats the CONTRIBUTING.md file in a special way and presents it
to users in various parts of the web UI, for example it show up in the
sidebar when creating new issues.

-- 
paul moore
www.paul-moore.com

Re: [PATCH] Add CONTRIBUTING

[Petr Lautrbach]

Paul Moore <paul@paul-moore.com> writes:

> On Wed, May 29, 2019 at 12:05 PM Paul Moore <paul@paul-moore.com> wrote:
>> On Wed, May 29, 2019 at 12:03 PM Petr Lautrbach <plautrba@redhat.com> wrote:
>> >
>> > 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
>>
>> I would suggest updating the wiki to point to this file if/when it is
>> merged upstream.
>
> Sorry, one more thing: you might consider adding the ".md" suffix so
> that GitHub and others will treat it as Markdown.  I know that GitHub
> also treats the CONTRIBUTING.md file in a special way and presents it
> to users in various parts of the web UI, for example it show up in the
> sidebar when creating new issues.


Using Contributing.md in code would mean that it could be directly
copied to wiki.

When you say include DCO directly in Contributing, do you mean something
like
https://github.com/bachradsusi/SELinuxProject-selinux/wiki/Contributing
?

Petr

Re: [PATCH] Add CONTRIBUTING

[Paul Moore]

On Fri, May 31, 2019 at 1:45 PM Petr Lautrbach <plautrba@redhat.com> wrote:
> Paul Moore <paul@paul-moore.com> writes:
> > On Wed, May 29, 2019 at 12:05 PM Paul Moore <paul@paul-moore.com> wrote:
> >> On Wed, May 29, 2019 at 12:03 PM Petr Lautrbach <plautrba@redhat.com> wrote:
> >> >
> >> > 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
> >>
> >> I would suggest updating the wiki to point to this file if/when it is
> >> merged upstream.
> >
> > Sorry, one more thing: you might consider adding the ".md" suffix so
> > that GitHub and others will treat it as Markdown.  I know that GitHub
> > also treats the CONTRIBUTING.md file in a special way and presents it
> > to users in various parts of the web UI, for example it show up in the
> > sidebar when creating new issues.
>
> Using Contributing.md in code would mean that it could be directly
> copied to wiki.

Another benefit, although I would encourage you to simply put a
pointer on the wiki to the repo file; duplicating the text is almost a
guarantee that one of those copies is going to go out of sync with the
other.

> When you say include DCO directly in Contributing, do you mean something
> like
> https://github.com/bachradsusi/SELinuxProject-selinux/wiki/Contributing
> ?

Yep.  In case you are wondering, here is what I did for libseccomp:

* https://github.com/seccomp/libseccomp/blob/master/CONTRIBUTING.md

-- 
paul moore
www.paul-moore.com

[PATCH v2] Add CONTRIBUTING.md

[Petr Lautrbach]

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

Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
---

github preview is available at
https://github.com/bachradsusi/SELinuxProject-selinux/blob/add-Contribution/CONTRIBUTING.md


 CONTRIBUTING.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..25c59eff
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,88 @@
+# 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 [user resources
+page](http://selinuxproject.org/page/User_Resources) for more
+information on mailing lists, documentation, and other resources.
+
+## Reporting Bugs
+
+All bugs and patches should be submitted to the [SELinux mailing
+list](https://lore.kernel.org/selinux) at selinux@vger.kernel.org.
+
+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 python-devel setools-devel swig ustr-devel
+
+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](https://lore.kernel.org/selinux) at selinux@vger.kernel.org. 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, see bellow.
+
+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.git
+
+# Developer Certificate of Origin
+
+    Developer's Certificate of Origin 1.1
+    
+    By making a contribution to this project, I certify that:
+    
+    (a) The contribution was created in whole or in part by me and I
+        have the right to submit it under the open source license
+        indicated in the file; or
+    
+    (b) The contribution is based upon previous work that, to the best
+        of my knowledge, is covered under an appropriate open source
+        license and I have the right under that license to submit that
+        work with modifications, whether created in whole or in part
+        by me, under the same open source license (unless I am
+        permitted to submit under a different license), as indicated
+        in the file; or
+    
+    (c) The contribution was provided directly to me by some other
+        person who certified (a), (b) or (c) and I have not modified
+        it.
+    
+    (d) I understand and agree that this project and the contribution
+        are public and that a record of the contribution (including all
+        personal information I submit with it, including my sign-off) is
+        maintained indefinitely and may be redistributed consistent with
+        this project or the open source license(s) involved.
+    
-- 
2.22.0.rc1

Re: [PATCH v2] Add CONTRIBUTING.md

[Paul Moore]

On Fri, May 31, 2019 at 4:19 PM Petr Lautrbach <plautrba@redhat.com> wrote:
>
> Based on https://github.com/SELinuxProject/selinux/wiki/Contributing
>
> Signed-off-by: Petr Lautrbach <plautrba@redhat.com>
> ---
>
> github preview is available at
> https://github.com/bachradsusi/SELinuxProject-selinux/blob/add-Contribution/CONTRIBUTING.md
>
>
>  CONTRIBUTING.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 88 insertions(+)
>  create mode 100644 CONTRIBUTING.md

Looks good to me.  I don't normally review/ack the userspace bits, but
since I commented previously and you made the changes I feel I should
:)

Acked-by: Paul Moore <paul@paul-moore.com>

> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
> new file mode 100644
> index 00000000..25c59eff
> --- /dev/null
> +++ b/CONTRIBUTING.md
> @@ -0,0 +1,88 @@
> +# 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 [user resources
> +page](http://selinuxproject.org/page/User_Resources) for more
> +information on mailing lists, documentation, and other resources.
> +
> +## Reporting Bugs
> +
> +All bugs and patches should be submitted to the [SELinux mailing
> +list](https://lore.kernel.org/selinux) at selinux@vger.kernel.org.
> +
> +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 python-devel setools-devel swig ustr-devel
> +
> +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](https://lore.kernel.org/selinux) at selinux@vger.kernel.org. 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, see bellow.
> +
> +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.git
> +
> +# Developer Certificate of Origin
> +
> +    Developer's Certificate of Origin 1.1
> +
> +    By making a contribution to this project, I certify that:
> +
> +    (a) The contribution was created in whole or in part by me and I
> +        have the right to submit it under the open source license
> +        indicated in the file; or
> +
> +    (b) The contribution is based upon previous work that, to the best
> +        of my knowledge, is covered under an appropriate open source
> +        license and I have the right under that license to submit that
> +        work with modifications, whether created in whole or in part
> +        by me, under the same open source license (unless I am
> +        permitted to submit under a different license), as indicated
> +        in the file; or
> +
> +    (c) The contribution was provided directly to me by some other
> +        person who certified (a), (b) or (c) and I have not modified
> +        it.
> +
> +    (d) I understand and agree that this project and the contribution
> +        are public and that a record of the contribution (including all
> +        personal information I submit with it, including my sign-off) is
> +        maintained indefinitely and may be redistributed consistent with
> +        this project or the open source license(s) involved.
> +
> --
> 2.22.0.rc1
>


-- 
paul moore
www.paul-moore.com

Re: [PATCH v2] Add CONTRIBUTING.md

[Stephen Smalley]

On 5/31/19 4:19 PM, Petr Lautrbach wrote:
> Based on https://github.com/SELinuxProject/selinux/wiki/Contributing
> 
> Signed-off-by: Petr Lautrbach <plautrba@redhat.com>

Merged with whitespace fixes applied.

> ---
> 
> github preview is available at
> https://github.com/bachradsusi/SELinuxProject-selinux/blob/add-Contribution/CONTRIBUTING.md
> 
> 
>   CONTRIBUTING.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++
>   1 file changed, 88 insertions(+)
>   create mode 100644 CONTRIBUTING.md
> 
> diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
> new file mode 100644
> index 00000000..25c59eff
> --- /dev/null
> +++ b/CONTRIBUTING.md
> @@ -0,0 +1,88 @@
> +# 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 [user resources
> +page](http://selinuxproject.org/page/User_Resources) for more
> +information on mailing lists, documentation, and other resources.
> +
> +## Reporting Bugs
> +
> +All bugs and patches should be submitted to the [SELinux mailing
> +list](https://lore.kernel.org/selinux) at selinux@vger.kernel.org.
> +
> +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 python-devel setools-devel swig ustr-devel
> +
> +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](https://lore.kernel.org/selinux) at selinux@vger.kernel.org. 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, see bellow.
> +
> +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.git
> +
> +# Developer Certificate of Origin
> +
> +    Developer's Certificate of Origin 1.1
> +
> +    By making a contribution to this project, I certify that:
> +
> +    (a) The contribution was created in whole or in part by me and I
> +        have the right to submit it under the open source license
> +        indicated in the file; or
> +
> +    (b) The contribution is based upon previous work that, to the best
> +        of my knowledge, is covered under an appropriate open source
> +        license and I have the right under that license to submit that
> +        work with modifications, whether created in whole or in part
> +        by me, under the same open source license (unless I am
> +        permitted to submit under a different license), as indicated
> +        in the file; or
> +
> +    (c) The contribution was provided directly to me by some other
> +        person who certified (a), (b) or (c) and I have not modified
> +        it.
> +
> +    (d) I understand and agree that this project and the contribution
> +        are public and that a record of the contribution (including all
> +        personal information I submit with it, including my sign-off) is
> +        maintained indefinitely and may be redistributed consistent with
> +        this project or the open source license(s) involved.
> +
>