Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (49 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

70 lines (49 loc) · 2.13 KB

Contributing Guide

Contributing to gradle-project-configuration is fairly easy. This document shows you how to get the project, run all provided tests and generate a production-ready build.

It also covers provided tasks that help you develop with gradle-project-configuration.

Dependencies

To make sure that the following instructions work, please install the following dependencies on you machine:

Installation

To get the source of gradle-project-configuration, clone the git repository via:

$ git clone git@github.com:gregoranders/gradle-project-configuration.git

This will clone the complete source to your local machine. Navigate to the project folder and install all needed dependencies via gradle:

$ ./gradlew clean check build

This commands installs everything which is required for building and testing the project.

Testing

Testing using Spock

./gradle clean test executes the unit tests.

Quality checks

./gradle clean check executes various code quality checks.

Building

./gradle clean build executes the build.

Contributing/Submitting changes

  • Check out a new branch based on development and name it to what you intend to do:
    • Example: 
      $ git checkout -b BRANCH_NAME origin/development
      If you get an error, you may need to fetch development first by using 
      $ git remote update && git fetch -p
    • Use one branch per fix/feature
  • Make your changes
    • Make sure to provide a spec for unit tests.
    • Run your tests with ./gradlew clean test.
    • Save integration time and run code quality checks locally with ./gradlew clean check
    • When all tests and checks pass, everything's fine.
  • Commit your changes
    • Please provide a git message that explains what you've done.
    • Commit to the forked repository.
  • Make a pull request
    • Make sure you send the PR to the development branch.
    • CI is watching you!