me/iced
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Improve CONTRIBUTING

Browse source
This commit is contained in:
Héctor Ramón Jiménez 2019-11-24 20:48:35 +01:00
parent 2d249d4eb9
commit 5941545a5d
2 changed files with 15 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

15
CONTRIBUTING.md
View file

@ -6,7 +6,18 @@ The main advice for new contributors is to share your ideas with the community.
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]! 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: Provided you get in touch first, all kinds of contributions are welcome! Here are a few interesting ideas:
- New widgets: toggle, table, grid, color picker, video...
- New renderers: `iced_piet` (already in the works!), `iced_skia`, `iced_raqote`, `iced_pathfinder`...
- New shells: `iced_sdl` could be useful for gamedev!
- Better style generation for `iced_web`
- Optimizations for `iced_wgpu`
- Alternative to [`wgpu_glyph`] for proper (shaped), efficient text rendering
- Time travelling debugger built on top of Iced itself
- Cool website to serve on https://iced.rs
Moreover, 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 - Writing tutorials or blog posts
- Improving the documentation - Improving the documentation
@ -16,5 +27,5 @@ Iced is in its infancy and, besides directly writing code, there are many other
[the ecosystem overview]: ECOSYSTEM.md [the ecosystem overview]: ECOSYSTEM.md
[the roadmap]: ROADMAP.md [the roadmap]: ROADMAP.md
[Zulip server]: https://iced.zulipchat.com/ [Zulip server]: https://iced.zulipchat.com/
[Code is the Easy Part]: https://youtu.be/DSjbTC-hvqQ?t=845 [Code is the Easy Part]: https://youtu.be/DSjbTC-hvqQ?t=1138
[The Hard Parts of Open Source]: https://www.youtube.com/watch?v=o_4EX4dPppA [The Hard Parts of Open Source]: https://www.youtube.com/watch?v=o_4EX4dPppA

2
ROADMAP.md
View file

@ -1,6 +1,8 @@
# Roadmap # Roadmap
This document describes the current state of Iced and some of the most important next steps we should take before it can become a production-ready GUI library. This list keeps the short term new features in sight in order to coordinate work and discussion. Therefore, it is not meant to be exhaustive. This document describes the current state of Iced and some of the most important next steps we should take before it can become a production-ready GUI library. This list keeps the short term new features in sight in order to coordinate work and discussion. Therefore, it is not meant to be exhaustive.
Before diving into the roadmap, check out [the ecosystem overview] to get an idea of the current state of the library.
## Next steps ## Next steps
Most of the work related to these features needs to happen in the `iced_native` path of the ecosystem, as the web already supports many of them. Most of the work related to these features needs to happen in the `iced_native` path of the ecosystem, as the web already supports many of them.