add CONTRIBUTING guide

.github/CONTRIBUTING.md

@@ -0,0 +1,63 @@
+# How to contribute ?
+
+## Installation
+
+This application is an electron app, so you need to have [Node.js](https://nodejs.org/fr) installed on your computer.
+
+It does also use yarn 4+, which is built-in with Node.js, but you may need to activate corepack doing this:
+
+```sh
+corepack enable
+```
+
+Then, you can install the dependencies with:
+
+```sh
+yarn install
+```
+
+## Understand the project
+
+The main code repository is located in the `src` folder.
+
+As an electron app, you should read the [Electron documentation](https://www.electronjs.org/docs) to understand how it works, and in particular, the [Process model](https://www.electronjs.org/docs/latest/tutorial/process-model):
+
+- The main process is the entry point of the application, and is responsible for creating the windows.
+- The renderer process is the one that runs in the browser, and is responsible for the UI.
+- The preload script is a script that runs in the renderer process, and can be used to expose APIs to the renderer process.
+
+### Main process
+
+In Tiana Tables, the main process is located in `src/main.ts`, and does import scripts from:
+
+- `src/configuration`: everything related to the configuration of the application
+- `src/sql`: everything related to the SQL queries
+- `src/main-process`: everything else that the main process need to handle (window management, developper tools, menu, etc.)
+
+### Renderer
+
+Everything that renders the UI is located in the `src/renderer` folder.
+
+It is [a ReactJS](https://react.dev/learn) application.
+
+- `src/renderer/components`: contains the components of the application,
+- `src/renderer/hooks`: contains global hooks, local hooks should be located in the component that uses them, or near them,
+- `src/renderer/routes`: contains the routes of the application, using [react-router](https://reactrouter.com/en/main),
+- `src/renderer/theme`: contains the theme of the application.
+
+### Preload
+
+The preload script is located in `src/preload.ts` or in the `src/preload/` directory, and is used to expose APIs to the renderer process.
+
+Simple APIs can be exposed directly in the `preload.ts` file, but more complex APIs should be located in the `src/preload/` directory.
+
+preload directory also contains TS enums named `XXXX_CHANNEL` that are used to communicate between the main process and the renderer process. There MUST be in a separate file, as you can not import preload file into the main process.
+
+Every channel value should be exposed via a preload script, and should be handled by a main process. You can check out the `src/preload/sqlChannel.ts` file that defines the `SQL_CHANNEL` enum, and the `src/main-process/sql.ts` file that handles the SQL queries.
+The `src/preload/sql.ts` file is used to expose the SQL queries to the renderer process (and is imported by the `src/preload.ts` file).
+
+## Translations
+
+Translations can be added to the [`locales`](locales/) directory. The file name should be the language code (e.g. `fr.ts` for French). The file should export a default value that must implement the [`Translation`](locales/type.ts) type (which is generated upon the english translations). Object keys are translation keys, and the values being the translated string.
+
+The default and reference locale is [`en.ts`](locales/en.ts).

README.md

@@ -30,8 +30,4 @@ You can download the latest release in the [Release page](https://github.com/jde
 
 ## Contributing
 
-### Translations
-
-Translations can be added to the [`locales`](locales/) directory. The file name should be the language code (e.g. `fr.ts` for French). The file should export a default value that must implement the [`Translation`](locales/type.ts) type (which is generated upon the english translations). Object keys are translation keys, and the values being the translated string.
-
-The default and reference locale is [`en.ts`](locales/en.ts).
+See [CONTRIBUTING.md](.github/CONTRIBUTING.md)