diff options
| author |  Héctor Ramón <hector0193@gmail.com> | 2019-11-21 18:01:48 +0100 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2019-11-21 18:01:48 +0100 |
| commit | 9712b319bb7a32848001b96bd84977430f14b623 (patch) | |
| tree | e9a40e89d05b353a8c8b37128b83c19c813f9da6 /CONTRIBUTING.md | |
| parent | 5adefdf6613bfe0738b573eab1d280fa041f5417 (diff) | |
| parent | 49349b75d92612e158f78fee84c70b172b4acd0e (diff) | |
| download | iced-9712b319bb7a32848001b96bd84977430f14b623.tar.gz iced-9712b319bb7a32848001b96bd84977430f14b623.tar.bz2 iced-9712b319bb7a32848001b96bd84977430f14b623.zip | |
Merge pull request #64 from hecrj/improvement/update-readmes
Update repository documentation
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 20 |
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 |