# HG changeset patch # User Peter Sanchez # Date 1596144040 25200 # Thu Jul 30 14:20:40 2020 -0700 # Node ID 466df0296da3a7c99bff43f24692ac19ca7da432 # Parent d372c9781928d2b960c3f33f84528293fd6a8e58 Adding contributing section to README files diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -422,6 +422,41 @@ py38-django3.0: commands succeeded congratulations :) +# 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 +`~petersanchez/public-inbox@lists.code.netlandish.com`. You can also view the +archives on the web here: + +https://lists.code.netlandish.com/~petersanchez/public-inbox + +To quickly setup your clone of `django-impersonate` to submit to the mailing +list just edit your `.hg/hgrc` file and add the following: + + [email] + to = ~petersanchez/public-inbox@lists.code.netlandish.com + + [patchbomb] + flagtemplate = "django-impersonate" + + [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 ==================== diff --git a/README.rst b/README.rst --- a/README.rst +++ b/README.rst @@ -1,9 +1,12 @@ django-impersonate |nlshield| -============================= +----------------------------- -:Info: Simple application to allow superusers to "impersonate" other non-superuser accounts. -:Version: 1.5.1 -:Author: Peter Sanchez (http://www.petersanchez.com) +Simple application to allow superusers to "impersonate" other +non-superuser accounts. + +**Version:** 1.5.1 + +**Author:** Peter Sanchez (http://www.petersanchez.com) Python / Django Support ======================= @@ -488,6 +491,44 @@ py38-django3.0: commands succeeded congratulations :) +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 +``~petersanchez/public-inbox@lists.code.netlandish.com``. You can also +view the archives on the web here: + +https://lists.code.netlandish.com/~petersanchez/public-inbox + +To quickly setup your clone of ``django-impersonate`` to submit to the +mailing list just edit your ``.hg/hgrc`` file and add the following: + +:: + + [email] + to = ~petersanchez/public-inbox@lists.code.netlandish.com + + [patchbomb] + flagtemplate = "django-impersonate" + + [diff] + git = 1 + +We have more information on the topic here: + +- `Contributing `__ +- `Using email with + Mercurial `__ +- `Mailing list + etiquette `__ + Copyright & Warranty ====================