# HG changeset patch # User Peter Sanchez # Date 1603397376 25200 # Thu Oct 22 13:09:36 2020 -0700 # Node ID 5300e70e4b9fa452b03f2ec1d53f86bca0053e19 # Parent 37c6341eeac1f8e63e915bf624c22a81e621c506 Adding contributing docs to the README diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -123,16 +123,49 @@ track_clicks=1, ) -Copyright & Warranty -==================== +# Contributing + +We accept patches submitted via `hg email` which is the `patchbomb` extension +included with Mercurial. + +Please see our [contributing document][cdoc] for more information. + +The mailing list where you submit your patches is +`~netlandish/public-inbox@lists.code.netlandish.com`. You can also view the +archives on the web here: + +https://lists.code.netlandish.com/~netlandish/public-inbox + +To quickly setup your clone of `sendypy` to submit to the mailing +list just edit your `.hg/hgrc` file and add the following: + + [email] + to = ~netlandish/public-inbox@lists.code.netlandish.com + + [patchbomb] + flagtemplate = "sendypy" + + [diff] + git = 1 + +We have more information on the topic here: + +- [Contributing][cdoc] +- [Using email with Mercurial][hgemail] +- [Mailing list etiquette][etiquette] + +[etiquette]: https://man.code.netlandish.com/lists/etiquette.md +[hgemail]: https://man.code.netlandish.com/hg/email.md +[cdoc]: https://man.code.netlandish.com/contributing.md + +# Copyright & Warranty All documentation, libraries, and sample code are Copyright 2016 Netlandish Inc., Peter Sanchez <>. The library and sample code are made available to you under the terms of the BSD license which is contained in the included file, BSD-LICENSE. -Commercial Support ------------------- +# Commercial Support This software, and lots of other software like it, has been built in support of many of Netlandish's own projects, and the projects of our diff --git a/README.rst b/README.rst --- a/README.rst +++ b/README.rst @@ -141,6 +141,44 @@ track_clicks=1, ) +Contributing +============ + +We accept patches submitted via ``hg email`` which is the ``patchbomb`` +extension included with Mercurial. + +Please see our `contributing +document `__ for more +information. + +The mailing list where you submit your patches is +``~netlandish/public-inbox@lists.code.netlandish.com``. You can also +view the archives on the web here: + +https://lists.code.netlandish.com/~netlandish/public-inbox + +To quickly setup your clone of ``sendypy`` to submit to the mailing list +just edit your ``.hg/hgrc`` file and add the following: + +:: + + [email] + to = ~netlandish/public-inbox@lists.code.netlandish.com + + [patchbomb] + flagtemplate = "sendypy" + + [diff] + git = 1 + +We have more information on the topic here: + +- `Contributing `__ +- `Using email with + Mercurial `__ +- `Mailing list + etiquette `__ + Copyright & Warranty ==================== @@ -150,7 +188,7 @@ which is contained in the included file, BSD-LICENSE. Commercial Support ------------------- +================== This software, and lots of other software like it, has been built in support of many of Netlandish's own projects, and the projects of our diff --git a/setup.py b/setup.py --- a/setup.py +++ b/setup.py @@ -18,7 +18,7 @@ url="https://code.netlandish.com/~netlandish/sendypy", long_description=long_description, platforms=["any"], - install_requires=["requests>=2.19.1"], + install_requires=["requests>=2.24.0"], classifiers=[ "Development Status :: 4 - Beta", "Intended Audience :: Developers",