summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMartin Fischer <martin@push-f.com>2022-02-08 04:30:09 +0100
committerMartin Fischer <martin@push-f.com>2022-02-08 04:41:21 +0100
commit489fe697cc12eb7cf3e12568546b4d133538ab6b (patch)
treee503396fa582774fdb3bc211e62a04e18109a63d /CONTRIBUTING.md
parent0d57be7ea30129000db5494e1a65b79c7618eed0 (diff)
create start page
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/