diff options
| author |  Héctor Ramón Jiménez <hector0193@gmail.com> | 2023-08-21 15:24:17 +0200 |
|---|---|---|
| committer | Héctor Ramón Jiménez <hector0193@gmail.com> | 2023-08-21 15:27:49 +0200 |
| commit | c31a63c1cc7191507beca451bcb391656a13e974 (patch) | |
| tree | 8c5352b4e3970d71838f53c47d44c11cedefdc69 /CONTRIBUTING.md | |
| parent | 3bea1f703cea137818c16bf41c7ea372bd8b91b9 (diff) | |
| download | iced-c31a63c1cc7191507beca451bcb391656a13e974.tar.gz iced-c31a63c1cc7191507beca451bcb391656a13e974.tar.bz2 iced-c31a63c1cc7191507beca451bcb391656a13e974.zip | |
Update `CONTRIBUTING` guidelines
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 19 |
1 files changed, 4 insertions, 15 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 412cf08f..9c4cacc8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,32 +2,21 @@ 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 [Discord server] or [start a discussion in an issue](https://github.com/iced-rs/iced/issues) explaining what you have in mind (do not be afraid of duplicated issues!). +The core team is busy and does not have time to mentor nor babysit new contributors. If a member of the core team thinks that reviewing and understanding your work will take more time and effort than writing it from scratch by themselves, your contribution will be dismissed. It is your responsibility to communicate and figure out how to help us! -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]! +The general advice for new contributors is to share your ideas with the community. Introduce yourself over our [Discord server] or [start a discussion](https://github.com/iced-rs/iced/discussions) explaining what you have in mind. This is a very important step. It helps to coordinate work, get on the same page, and start building trust. Remember that [Code is the Easy Part] and also [The Hard Parts of Open Source]! -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`: tiling, incremental rendering... -- Alternative to [`wgpu_glyph`] for proper (shaped), efficient text rendering -- Time travelling debugger built on top of Iced itself -- Testing library -- Cool website to serve on https://iced.rs +Once you have started a channel of communication, you must wait until someone from the core team chimes in. If the core team is busy, this can take a long time (maybe months!). Your idea may need a bunch of iteration, or it may turn into something completely different, or it may be completely discarded! You will have to be patient and humble. Remember that open-source is a gift. 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 +- Sharing, discussing, researching and exploring new ideas or crates [the ecosystem overview]: ECOSYSTEM.md [the roadmap]: ROADMAP.md [Discord server]: https://discord.gg/3xZJ65GAhd [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 -[`wgpu_glyph`]: https://github.com/hecrj/wgpu_glyph |