Add CONTRIBUTING.md

This commit is contained in:
Héctor Ramón Jiménez 2019-11-20 12:36:49 +01:00
parent 7f1c6fc14c
commit 1094968e43

20
CONTRIBUTING.md Normal file
View File

@ -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