mirror of
https://github.com/Wessel/c-websocket-server.git
synced 2026-07-14 12:34:10 +02:00
feat: Populate repo
This commit is contained in:
50
.github/CONTRIBUTING.md
vendored
Normal file
50
.github/CONTRIBUTING.md
vendored
Normal file
@@ -0,0 +1,50 @@
|
||||
# Contributing
|
||||
|
||||
<!---
|
||||
Used linters:
|
||||
[ESLint](https://eslint.org/)
|
||||
[EditorConfig](https://editorconfig.org)
|
||||
--->
|
||||
|
||||
If you wish to contribute to C Websocket Server, feel free to fork the repository and submit a pull request.
|
||||
[EditorConfig](https://editorconfig.org) is enforced to correct most typo's you make and keep the code style the same throughout the whole project,
|
||||
so it would be much appreciated if you installed [EditorConfig](https://editorconfig.org) to your editor of choice
|
||||
|
||||
<!---
|
||||
Prerequisites for Node.JS:
|
||||
|
||||
* [Node.JS V18.14.0](https://nodejs.org/en/)
|
||||
* [Docker](https://www.docker.com)
|
||||
* [ESLint](https://eslint.org)
|
||||
* [(OPTIONAL) Yarn](https://yarnpkg.com)
|
||||
--->
|
||||
## Prerequisites
|
||||
The following prerequisites must be met before installing C Websocket Server:
|
||||
* libmysqlclient
|
||||
* gcc
|
||||
* json-c
|
||||
|
||||
<!---
|
||||
Install commands:
|
||||
JavaScript/TypeScript: `yarn --dev` or `npm install --dev`
|
||||
Rust: `cargo run`
|
||||
C: `make clean install`
|
||||
|
||||
Run commands:
|
||||
JavaScript/TypeScript: `yarn test` or `npm run test`
|
||||
Rust: `cargo run`
|
||||
C: `make clean dev`
|
||||
--->
|
||||
## Setup
|
||||
To get ready to work on the codebase, please do the following:
|
||||
|
||||
1. Fork & clone the repository, and make sure you are on the **master** branch
|
||||
2. Code your ideas and test them using `make clean test`
|
||||
3. [Submit a pull request](https://github.com/wessel/c-websocket-server/compare)
|
||||
|
||||
## Testing
|
||||
When creating any new functions, please also create unit tests for them in the `tests` directory.
|
||||
Use the library associated with the project when creating such tests.
|
||||
|
||||
When modifying existing functions, make sure to test them before making a pull request, this will prevent
|
||||
anything from breaking on the production environment.
|
||||
Reference in New Issue
Block a user