Add more info to contributing. Fixes #429

[lemmy.git] / docs / src / contributing.md

diff --git a/docs/src/contributing.md b/docs/src/contributing.md
index 4f29af3dacd51951912e2bd441d898b7967fb60c..e73cc4b9bbd284afafe11e37b13ef0ee5e98d7bf 100644 (file)
--- a/docs/src/contributing.md
+++ b/docs/src/contributing.md
@@ -1 +1,32 @@
-Information about contributing to Lemmy, whether it is translating, testing, designing or programming.
\ No newline at end of file
+# Contributing
+
+Information about contributing to Lemmy, whether it is translating, testing, designing or programming.
+
+## Translating
+
+Go [here](https://github.com/dessalines/lemmy#translations) for translation instructions.
+
+## Architecture
+
+### Front end
+
+- The front end is written in `typescript`, using a react-like framework called [inferno](https://infernojs.org/). All UI elements are reusable `.tsx` components.
+- The main page and routing are in `ui/src/index.tsx`.
+- The components are located in `ui/src/components`.
+
+### Back end
+
+- The back end is written in `rust`, using `diesel`, and `actix`.
+- The server source code is split into main sections in `server/src`. These include: 
+  - `db` - The low level database actions.
+    - Database additions are done using diesel migrations. Run `diesel migration generate xxxxx` to add new things.
+  - `api` - The high level user interactions (things like `CreateComment`)
+  - `routes` - The server endpoints .
+  - `apub` - The activitypub conversions.
+  - `websocket` - Creates the websocket server. 
+
+## Linting / Formatting
+
+- Every front and back end commit is automatically formatted then linted using `husky`, and `lint-staged`.
+- Rust with `cargo fmt` and `cargo clippy`.
+- Typescript with `prettier` and `eslint`.