summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-11-20 12:36:49 +0100
committerLibravatar Héctor Ramón Jiménez <hector0193@gmail.com>2019-11-20 12:36:49 +0100
commit1094968e43ddb7a217fbdd0426236325b499c8fb (patch)
treec147636f11b36ce30ee8df6d3f1741cd0bedbdd8 /CONTRIBUTING.md
parent7f1c6fc14cddbf7055a4d00a4c188311592e679e (diff)
downloadiced-1094968e43ddb7a217fbdd0426236325b499c8fb.tar.gz
iced-1094968e43ddb7a217fbdd0426236325b499c8fb.tar.bz2
iced-1094968e43ddb7a217fbdd0426236325b499c8fb.zip
Add `CONTRIBUTING.md`
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..1a8d6164
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,20 @@
+# Contributing
+
+Thank you for considering contributing to Iced! Feel free to read [the ecosystem overview] and [the roadmap] to get an idea of the current state of the library.
+
+The main advice for new contributors is to share your ideas with the community. Introduce yourself over our [Zulip server] or [start a discussion in an issue](https://github.com/hecrj/iced/issues) explaining what you have in mind (do not be afraid of duplicated issues!). If you want to talk directly to me (@hecrj), you can also find me on Discord (`lone_scientist#9554`).
+
+This is a very important step. It helps to coordinate work, get on the same page, and start building trust. Please, do not skip it! Remember that [Code is the Easy Part] and also [The Hard Parts of Open Source]!
+
+Iced is in its infancy and, besides directly writing code, there are many other different ways you can contribute. To name a few:
+
+- Writing tutorials or blog posts
+- Improving the documentation
+- Submitting bug reports and use cases
+- Sharing, discussing, researching and exploring new ideas
+
+[the ecosystem overview]: ECOSYSTEM.md
+[the roadmap]: ROADMAP.md
+[Zulip server]: https://iced.zulipchat.com/
+[Code is the Easy Part]: https://youtu.be/DSjbTC-hvqQ?t=845
+[The Hard Parts of Open Source]: https://www.youtube.com/watch?v=o_4EX4dPppA