summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..3e25908
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+## 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].
+
+[email]: mailto:martin@push-f.com
+[#pydoc]: https://web.libera.chat/?channel=#pydoc
+[Libera.Chat]: https://libera.chat/
+[pydoctor]: https://github.com/twisted/pydoctor
+[docstrings]: https://www.python.org/dev/peps/pep-0257/