Skip to content

Latest commit

 

History

History
82 lines (66 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

82 lines (66 loc) · 3.43 KB
Raw

Contribute to balloon web client

Did you find a bug or would you like to contribute a feature? You are certainly welcome to do so. Please always fill an issue first to discuss the matter. Do not start development without an open issue otherwise we do not know what you are working on.

Bug

If you just want to fill a bug report, please open your issue. We are encouraged to fix your reported bug to provide best software for the opensource community.

Security flaw

Do not open an issue for a possible security vulnerability, to protect yourself and others please contact opensource@gyselroth.net to report your concern.

Git

You can clone the repository from:

git clone https://github.com/gyselroth/balloon-client-web.git

Recomended setup for development

Get the base and install dependencies

git clone https://github.com/gyselroth/balloon-client-web.git
npm install

Balloon Server

You will need a balloon server to develop the web ui. Easiest way is to grap the balloon docker image.

git clone https://github.com/gyselroth/balloon-dockerimage
cd balloon-dockerimage
docker build -t balloon .
cd ..
docker run balloon

Start the magic

npm start will start a local development server, you can access the web ui at http://localhost:8080. If you cachange any file within the source, your ui will automatically rebuild itself, you do not have to reload your browser, this will happen automatically.

npm start

Building

Besides npm scripts like build and start you can use make to build this software. The following make targets are supported:

  • build Build software, but do not package
  • clean Clear build and dependencies
  • deb Create debian packages
  • deps Install dependencies
  • npm Update dependencies
  • dist Distribute (Create tar and deb packages)
  • tar Create tar package
  • webpack Package build
  • eslint Enforce code policy

Git commit

Please make sure that you always specify the number of your issue starting with a hastag (#) within any git commits.

Pull Request

You are absolutely welcome to submit a pull request which references an open issue. Please make sure you're follwing coding standards and be sure all your modifications pass the build. Build Status

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

This software is freely available under the terms of GPL-3.0, please respect this license and do not contribute software which ist not compatible with GPL-3.0 or is not your work.

Editor config

This repository gets shipped with an .editorconfig configuration. For more information on how to configure your editor please visit editorconfig.

Code policy

Add the following script to your git pre-commit hook file, otherwise your build will fail if you do not following code style:

./node_modules/.bin/eslint --fix src *.js

This automatically converts your code into the code style guidelines of this project.