rss2email.git
11 years agoCONTRIBUTING.md: point to external docs on GitHub
W. Trevor King [Sat, 8 Dec 2012 15:32:48 +0000 (10:32 -0500)]
CONTRIBUTING.md: point to external docs on GitHub

This translates CONTRIBUTING (from the `contributing` branch) into
Markdown using a GitHub URL for the link.  Merging this into your
project will set it up to use GitHub's CONTRIBUTING infrastructure,
and will be used to notify users creating issues and pull requests
[1].

GitHub's blob URL syntax is [2]:

  https://github.com/<user>/<project>/blob/<commit-SHA-1>/Path/To/File

Like CONTRIBUTING, CONTRIBUTING.md is also released under the CC0
Universal license (see the `license` branch for full text).

[1]: https://github.com/blog/1184-contributing-guidelines
[2]: https://help.github.com/articles/how-do-i-get-a-permanent-link-from-file-view-to-permanent-blob-url

Signed-off-by: W. Trevor King <wking@tremily.us>
12 years agoCONTRIBUTING: point to external docs (for non GPLv2= projects)
W. Trevor King [Mon, 26 Nov 2012 14:31:02 +0000 (09:31 -0500)]
CONTRIBUTING: point to external docs (for non GPLv2= projects)

If a project wants to use the DCO/s-o-b workflow, but can't because of
license incompatibility, they can include this blurb pointing towards
the external documentation.  To avoid licensing issues with this
CONTRIBUTING file itself, I'm releasing it under the Creative Commons
CC0 1.0 Universal license (see the `license` branch for full text).

If you use this in your project, you'll probably want to adjust the
URL to point to somewhere more dependable.  It's annoyingly long, but
you should include the blob hash (or a higher level hash like the
commit hash) in your URL to make it absolutely clear which version of
the documentation you were using in your project at a particular time.

Signed-off-by: W. Trevor King <wking@tremily.us>