diff --git a/contributing.md b/contributing.md new file mode 100644 index 0000000..ae2afb8 --- /dev/null +++ b/contributing.md @@ -0,0 +1,26 @@ +# Contributing to the project + +* Writing chat clients + +I know not everyone wants an electron based client because it's naturally really bloated. But the normans want something that _just werks_ so electron is a good way of doing that. + +The API is dead simple however so it shouldn't be too bad to write a simple client that sends a couple of requests every so often. + +If you choose to write a client and want people to know about it I can include a link to the project here/on the wiki. + +* Testing + +Currently API testing is done with a phony client written in python(client-tests/client.py) and some rust tests. + +Anything from a simple `GET /some-route` + response check to a testing pipeline thing is appreciated. +Since testing doesn't really affect users as long as the test is correct and covers new ground it's welcome. + +* Languages - Rust/Python/Bash/Javascript/HTML/CSS + +The API service is written in rust. Uses mysql-async wrapped in a small library for abstracting away database code from the "business logic" + +Build scripts are literally just Bash scripts + +The electron client is built with NodeJS + Bootstrap(nothing else). +Adding libraries to the client requires _very_ good reason IMO. + diff --git a/readme.md b/readme.md index 704f3e1..d8cccd7 100644 --- a/readme.md +++ b/readme.md @@ -42,18 +42,4 @@ Long: No. A basic client is still underway and the chat API is missing a metric ## How to help - if you want to - -> Writing chat clients - -I know not everyone wants an electron based client because it's naturally really bloated. But the normans want something that _just werks_ so electron is a good way of doing that. - -The API is dead simple however so it shouldn't be too bad to write a simple client that sends a couple of requests every so often. - -If you choose to write a client and want people to know about it I can include a link to the project here/on the wiki. - -> Testing - -Currently API testing is done with a phony client written in python(client-tests/client.py) and some rust tests. - -Anything from a simple `GET /some-route` + response check to a testing pipeline thing is appreciated. -Since testing doesn't really affect users as long as the test is correct and covers new ground it's welcome. +Check [the contributing guide](./contributing.md)