Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

50 lines (34 loc) · 2.26 KB
Raw

Fabric8-Launcher Backend Contributing Guide

If you're looking for a development guide for the Fabric8-Launcher Backend, first read the readme.

First Steps

Prerequisites

  • Java 8+
  • Maven 3.5.3+
  • Git

GitHub Workflow

To contribute to the Fabric8-Launcher Backend:

  1. Fork this repository to your own Git.
  2. Clone your fork.
  3. Commit/Push your work on topic branches
  4. Make pull requests.

Here are 3 simple rules we follow:

  • Use a fork of our repository with a topic branch to contribute.
  • Redact a nice commit/pull-request message following our guide.
  • Try to keep a clean commit log (no unnecessary commits, no merge commits).

In order to make you feel safe regarding your contribution, we are here to help you:

  • Unit/Integration tests and checkstyle are run for every modification you make.
  • There is a test keeper plugin so you don't forget to test your changes if necessary.
  • Our team will review your contribution and help you to get your changes in.
  • For any question, you can comment your PR or Issue or send an email to the team.

Here are some articles we thought you might like:

Build, Test and Run

You can find all those information in the readme.

Choosing issues to work on

If you're wondering what issues would be suitable when you're just getting started, we recommend taking a look at the issues with the 'good first issue' and 'help wanted' labels.

License Information and Contributor Agreement

  • This project is under Apache License Version 2.0.
  • There is no need to sign a contributor agreement to contribute to the Fabric8-Launcher.
  • There is no need to add any specific license header to the source code.