From 31633f047523c755412c520bfc9c7a0b8988921d Mon Sep 17 00:00:00 2001 From: Thomas Endres Date: Fri, 13 Jul 2018 21:17:37 +0200 Subject: [PATCH] Added sections on how to contribute Signed-off-by: Thomas Endres --- CONTRIBUTING.md | 11 +++++++++++ README.md | 6 ++++-- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d30f2b6b..09cd2bd9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,17 @@ Contributions are very welcome. The following will provide some helpful guidelines. +## How to contribute + +We love pull requests. Here is a quick guide: + +2. Fork the repo. +3. Create a new branch from master. +5. Add your change together with necessary tests. +6. Run `mvn clean build` and ensure all tests are passing. +7. Commit and push to your fork/branch and submit a pull request. Don't forget to sign-off your commit (see next section). +8. Create a pull request. + ## Sign your work - the Developer's Certificate of Origin The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org): diff --git a/README.md b/README.md index 6dcf964b..e8f93eca 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ Java Config-Builder [![Build Status](https://travis-ci.org/TNG/config-builder.svg?branch=master)](https://travis-ci.org/TNG/config-builder) [![Coverage Status](https://coveralls.io/repos/TNG/config-builder/badge.svg?branch=master&service=github)](https://coveralls.io/github/TNG/config-builder?branch=master) - [![Dependency Status](https://www.versioneye.com/user/projects/56989a13af789b002e000b72/badge.svg?style=flat)](https://www.versioneye.com/user/projects/56989a13af789b002e000b72) - [![MavenCentral](https://img.shields.io/maven-central/v/com.tngtech.java/config-builder.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.tngtech.java%22%20AND%20a%3A%22config-builder%22) [![Stories in Ready](https://badge.waffle.io/TNG/config-builder.png?label=ready&title=Ready)](http://waffle.io/TNG/config-builder) =================== @@ -210,3 +208,7 @@ A sample presentation can be found at http://tng.github.io/config-builder Java Doc -------- Full javadoc of the code can be found here http://tng.github.io/config-builder/javadoc + +How to contribute +----------------- +Please have a look at [CONTRIBUTING.md](CONTRIBUTING.md)