Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 2.23 KB

DEVELOPMENT.md

File metadata and controls

76 lines (52 loc) · 2.23 KB
Raw

Development

This doc explains the development workflow so you can get started contributing to gocheckcov!

Supported Golang versions

  • 1.11.x
  • 1.12.x
  • 1.13.x

Getting started

First you will need to setup your GitHub account and create a fork:

  1. Create a GitHub account
  2. Setup GitHub access via SSH
  3. Create and checkout a repo fork

When you're ready, you can create a PR!

Checkout your fork

The Go tools require that you clone the repository to the src/github.com/cvgw/gocheckcov directory in your GOPATH.

To check out this repository:

  1. Create your own fork of this repo
  2. Clone it to your machine:
mkdir -p ${GOPATH}/src/github.com/cvgw
cd ${GOPATH}/src/github.com/cvgw
git clone [email protected]:${YOUR_GITHUB_USERNAME}/gocheckcov.git
cd gocheckcov
git remote add upstream [email protected]:cvgw/gocheckcov.git
git remote set-url --push upstream no_push

Adding the upstream remote sets you up nicely for regularly syncing your fork.

Testing gocheckcov

gocheckcov has unit tests

Unit Tests

The unit tests live with the code they test and can be run with:

make test

These tests will not run correctly unless you have checked out your fork into your $GOPATH.

Creating a PR

When you have changes you would like to propose to gocheckcov, you will need to:

  1. Ensure the commit message(s) describe what issue you are fixing and how you are fixing it (include references to issue numbers if appropriate)
  2. Create a pull request

Reviews

Each PR must be reviewed by a maintainer.