Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

55 lines (40 loc) · 1.5 KB
Raw

Contributing

The simplest way of contributing is to create a new issue using the corresponding templates for feature-requests and bug-reports.

If you are able to, you can also create a pull request to add the wanted features or fix the found bug yourself. Any contribution is highly appreciated!

Setup

To start working on this project, run the following series of commands:

git clone https://github.com/MauriceNino/dashdot &&\
  cd dashdot &&\
  yarn &&\
  yarn build

After that, you might need to restart Visual Studio Code, because otherwise there can be some errors with Typescript.

When you are done with all that, you can start a dev server using docker-compose with:

yarn dev

Network

If you want to have a speedtest result in your network graph, create a file at the root of the project named speedtest_result, with the following content and then restart your backend.

{
  "unit": "byte",
  "speedDown": 150000000,
  "speedUp": 50000000
}

Git

Development is done on the dev branch, so please use that as the base branch in your work.

This project uses semantic commit messages - if you are unsure on how to create a semantic commit message, you can check out the Semantic Commit Message Standards, or run the interactive commit message creator, which will create the commit message for you:

yarn commit