Skip to content

Latest commit

 

History

History
67 lines (48 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

67 lines (48 loc) · 1.94 KB

Contributing Guide

Contributing to com.github.gregoranders.template 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 com.github.gregoranders.template.

Dependencies

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

  • JAVA 17
  • Git

Installation

To get the source of com.github.gregoranders.template, clone the git repository via:

$ git clone https://github.com/gregoranders/com.github.gregoranders.template

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

$ ./gradlew build

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

Testing

Unit testing using Spock

./gradle test executes the unit tests.

Building

./gradle check 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
    • 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 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!