Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.62 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.62 KB
Raw

Thank you for considering to contribute to "bridge."

Starting development

We recommend Visual Studio Code to edit our code base. In order to get started testing the application, you need to install NodeJS. Open the terminal, cd to the directory you have cloned "bridge." to and run npm i. Afterwards, you can use npm run dev and npm run build to start the development environment and build versions of "bridge.".

Native Builds

We use Tauri to build native versions of bridge. v2. If you want to run the native app in development mode, follow the steps described here. Afterwards, run cargo install tauri-cli to install the Tauri CLI. You can now run cargo tauri dev to start the native app in development mode.

Code Rules

Verified as working

All code contributed to this repository should be verified as working, meaning you've tested the functionality at least once and didn't encounter unexpected behaviour. Building the application also may not contain errors inside the console.

Code Style

General

This code base uses Prettier to automatically style code before committing it. We recommend installing the Prettier extension for VS Code for the smoothest experience.

Names

All identifier names should be camelCase.

// Example
let myVar = 'Hello World!'

function doSomethingNow(par1, par2) {
	doSomething(par1 + par2)
}

Opening a Pull Request

Please make sure that you have been working with the "dev" branch. Pull request should use the "dev" branch as their base.