From e7ea7ed1c4cb478490a85cb47fc8f1d31db65ec9 Mon Sep 17 00:00:00 2001 From: Valerio Ageno Date: Thu, 15 Aug 2024 21:07:28 +0200 Subject: [PATCH] feat: improve contributing documentation --- .../src/routes/documentation/contributing.mdx | 38 ++++++++++++------- 1 file changed, 24 insertions(+), 14 deletions(-) diff --git a/apps/documentation/src/routes/documentation/contributing.mdx b/apps/documentation/src/routes/documentation/contributing.mdx index 04c33bdd..56bdaccc 100644 --- a/apps/documentation/src/routes/documentation/contributing.mdx +++ b/apps/documentation/src/routes/documentation/contributing.mdx @@ -10,7 +10,7 @@ import Breadcrumbs, { Element } from '../../components/breadcrumbs' -# How to contribute +# Contributing ## TL;DR @@ -18,23 +18,33 @@ The project is massive - if you like it do consider to contribute! ## Getting started -The project priorities right now are: +The `tuono` project can mostly be split by the following sub-domains: -- Improve the documentation website -- Improve the tuono CLI -- Improve the rust backend -- Improve the react frontend +- The CLI +- The rust backend +- The react frontend +- The documentation website (which is written with tuono 🚀) -Currently I'm keeping a private dashboard to prioritize new features and bug fixes. +To check what are the knowledge requirement for each domain check the +[requirements](/documentation/contributing?#requirements) section below. -If you want to propose something please open a new issue on github or reach me using -my email address [valerioageno@yahoo.it](mailto:valerioageno@yahoo.it) - -I'm also available on twitter (X) DMs `@valerioageno`, [linkedin](https://www.linkedin.com/in/valerioageno) +Currently I'm keeping a private dashboard to prioritize new features and bug fixes but if you +want to propose something please open a new issue on github or reach me using +my email address [valerioageno@yahoo.it](mailto:valerioageno@yahoo.it). I'm also available +on twitter (X) DMs `@valerioageno`, [linkedin](https://www.linkedin.com/in/valerioageno) and discord `@__v__v__`. ## Requirements -To contribute is not strictly required to know both typescript and rust (even though it -would be a great nice to have). Most of the feature tasks and bugfixes can be handled solely on -the client or on the server side. +It's not strictly required to know both React (& typescript) and Rust (even though it +would be a great nice to have). + +Without taking into account specific cases we can mostly split the domain requirements by: + +- The `CLI` needs Rust knowledge (even though a couple of scenario might need also Typescript) +- The Backend needs just `Rust` +- The Frontend needs just `React` & `Typescript` +- The documentation website needs just `React` & `Typescript` (or even less since most of the +code is markdown). + +