From bc09901690cfb0ca319e9fe4d009378ee9f46cf8 Mon Sep 17 00:00:00 2001 From: Redhawk18 Date: Tue, 18 Jul 2023 14:09:33 -0400 Subject: Simplify contributing guidelines --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8782a2e3..412cf08f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ 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!). If you want to talk directly to me (@hecrj), you can also find me on Discord (`lone_scientist#9554`). +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!). 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]! -- cgit From c31a63c1cc7191507beca451bcb391656a13e974 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Mon, 21 Aug 2023 15:24:17 +0200 Subject: Update `CONTRIBUTING` guidelines --- CONTRIBUTING.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) (limited to 'CONTRIBUTING.md') 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 -- cgit From fb02040b39b5be5125c1ed2e0f14b92479ba3fdb Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Mon, 21 Aug 2023 15:26:49 +0200 Subject: Clarify the `CONTRIBUTING` guidelines a bit --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c4cacc8..a3081b96 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ 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 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! +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 reduce the likelihood of this! 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]! -- cgit From c9bd48704dd9679c033dd0b8588e2744a3df44a0 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Sat, 26 Aug 2023 19:32:09 +0200 Subject: Replace GitHub discussions with Discourse --- CONTRIBUTING.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a3081b96..c01acc4e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ Thank you for considering contributing to Iced! Feel free to read [the ecosystem 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 reduce the likelihood of this! -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]! +The general advice for new contributors is to share your ideas with the community. You can share your ideas and gather feedback in [our Discourse forum]. 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]! 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. @@ -17,6 +17,7 @@ Besides directly writing code, there are many other different ways you can contr [the ecosystem overview]: ECOSYSTEM.md [the roadmap]: ROADMAP.md -[Discord server]: https://discord.gg/3xZJ65GAhd +[our Discourse fourm]: https://discourse.iced.rs/ +[our 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 -- cgit From 9245423c5d82f88c99adecaaf5dd2ac3559a05a8 Mon Sep 17 00:00:00 2001 From: Héctor Ramón Jiménez Date: Mon, 11 Sep 2023 01:10:31 +0200 Subject: Fix link in `CONTRIBUTING` guide --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'CONTRIBUTING.md') diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c01acc4e..4e7075c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,7 +17,6 @@ Besides directly writing code, there are many other different ways you can contr [the ecosystem overview]: ECOSYSTEM.md [the roadmap]: ROADMAP.md -[our Discourse fourm]: https://discourse.iced.rs/ -[our Discord server]: https://discord.gg/3xZJ65GAhd +[our Discourse forum]: https://discourse.iced.rs/ [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 -- cgit