[FFmpeg-devel] [PATCH] add CONTRIBUTING.md

Stefano Sabatini stefasab at gmail.com
Tue Oct 6 18:37:47 CEST 2015


On date Tuesday 2015-10-06 08:20:11 -0800, Lou Logan encoded:
> On Tue, Oct 6, 2015, at 07:07 AM, Stefano Sabatini wrote:
> > 
> > I wonder if adding the contents to README.md is not a better choice
> > 
> > Note also since we're writing about github, that the README.md will
> > have a better visibility there, since it is shown on the project main
> > page:
> > https://github.com/FFmpeg/FFmpeg
> 
> I forgot to mention that main reason for making this is to address this:
> 
> https://github.com/FFmpeg/FFmpeg/pull/153
> 
> README.md is already displayed on the Github page, but CONTRIBUTING.md
> should add a notification banner as shown in the link above. The idea is
> to attempt to reduce the number of Github pull requests since the vast
> majority of us don't pay attention to them.

Makes sense. 

> If you prefer I can remove everything but the "Note to Github Users" and
> then mention they should refer to README.md for more info.

If we keep CONTRIBUTING.md, better to make it independent from Github
- that is I'm suggesting that we move all contributing indications to
README.md, or we keep them in a separate file CONTRIBUTING.md, as
proposed by this patch.

In case we adopt the second solution (which I'm fine with), then you
could mention CONTRIBUTING.md in README.md and remove the
corresponding section, since otherwise you're duplicating the
information stated in README.md.
-- 
FFmpeg = Frenzy & Frenzy Mean Power Empowered Gem


More information about the ffmpeg-devel mailing list