shockrah/freechat
shockrah/freechat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

contributing guide

Browse Source
This commit is contained in:
shockrah 2020-12-12 16:19:36 -08:00
parent f375fb74b7
commit f7136c0258
2 changed files with 27 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
contributing.md Normal file
View File

@ -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.

16
readme.md
View File

@ -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 ## How to help - if you want to
Check [the contributing guide](./contributing.md)
> 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.