Re: [PATCH] Add CONTRIBUTING

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Fri, May 31, 2019 at 1:45 PM Petr Lautrbach <plautrba@xxxxxxxxxx> wrote:
> Paul Moore <paul@xxxxxxxxxxxxxx> writes:
> > On Wed, May 29, 2019 at 12:05 PM Paul Moore <paul@xxxxxxxxxxxxxx> wrote:
> >> On Wed, May 29, 2019 at 12:03 PM Petr Lautrbach <plautrba@xxxxxxxxxx> wrote:
> >> >
> >> > Based on https://github.com/SELinuxProject/selinux/wiki/Contributing
> >> >
> >> > Signed-off-by: Petr Lautrbach <plautrba@xxxxxxxxxx>
> >> > ---
> >> >  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



[Index of Archives]     [Selinux Refpolicy]     [Linux SGX]     [Fedora Users]     [Fedora Desktop]     [Yosemite Photos]     [Yosemite Camping]     [Yosemite Campsites]     [KDE Users]     [Gnome Users]

  Powered by Linux