From 091d3f39435da9de77d0492686acd7bba6f79357 Mon Sep 17 00:00:00 2001 From: Martin Fischer Date: Thu, 10 Feb 2022 09:17:18 +0100 Subject: merge CONTRIBUTING.md into README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 6f185bf..5c282c2 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,26 @@ often is not structured after the Python modules. It works by downloading the source files from the [Python Package Index], the API documentation is then generated with [pydoctor]. + + +## How to contribute + +* You can give feedback and suggest packages to be included, + either by [email] or in the [#pydoc] IRC channel on [Libera.Chat]. + +* You can contribute to [pydoctor]. + +* You can contribute to the individual Python projects + to improve their [docstrings]. + +* If you want to support pydoc.dev by providing hosting, + [please get in touch][email]. + [Sphinx]: https://www.sphinx-doc.org/ [docs.rs]: https://docs.rs/ [Python Package Index]: https://pypi.org/ [pydoctor]: https://github.com/twisted/pydoctor +[email]: mailto:martin@push-f.com +[#pydoc]: https://web.libera.chat/?channel=#pydoc +[Libera.Chat]: https://libera.chat/ +[docstrings]: https://www.python.org/dev/peps/pep-0257/ -- cgit v1.2.3