Skip to content

Latest commit

 

History

History
93 lines (68 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

93 lines (68 loc) · 3.44 KB
Raw

How to contribute to MAPA

Found a bug?

Please let us know about any bugs you find via the github issue editor. Click here and report what you experienced and what you would have expected to happen. Please follow next issue template:

  1. Description of problem.
  2. Steps to reproduce a bug.
  3. What result do you expect from app.

Pull Request

We are happy about any contribution via a pull request. To be able to easily accept your pull request, please stick to the following Style Guide.

Small guide how to use git:

  1. You just make your own fork оf project.
  2. Clone your fork to your local machine with
git clone <your_repo>
  1. Make changes to code. It's recommended to do every feature in it's own branch. Push you result to your fork with
git push origin <your_branch_name>
  1. And make a pull request wiith your changes to MAPA original repo.

Beginner Developer Guide

If you want to contribute but do not know all the used technologies, then don't worry. In the following lines you find a step-by-step manual how to get started and help us with developing on KVM (Karte von morgen).

Setup your system

You can use any operating system but for this guide we use the commands for linux (e.g. Kubuntu 16.04 LTS). For another operating system it should be easy to find out the equivalent commands by googling.

Install Node and npm that we'll need to build the app:

sudo apt-get install nodejs nodejs-legacy npm

To manage the source code and to keep track of changes, git will help you:

sudo apt-get install git

Great, that's it! Your are done!

Learn the basics

If you've never done that it's a good idea to first play around with the following web development basics before continuing:

  • JavaScript
  • HTML
  • CSS

React & Redux

As a framework KVM uses React with redux.

Here is a great talk and comic which explains why Redux is a good idea (they are about Flux but all of this is also valid for Redux which is the next stage after Flux).

Then you should be prepared to have a look at the framework. I recommend to read at least the introduction and the basics sections as a first overview. Now, let's put React and Redux together, for example with this "Step by Step Guide To Building React Redux Apps".

The framework that connects React and Redux in the end is react-redux.

That's it. Everything else is a matter of detail. Nevertheless here are some more libs used and you should/could know about: