Skip to content

Latest commit

 

History

History
98 lines (67 loc) · 3.6 KB

CONTRIBUTING.md

File metadata and controls

98 lines (67 loc) · 3.6 KB
Raw

Hello! Thank you for choosing to help contribute to Health-Check. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.

There are a few ways to contribute, which we'll enumerate below:

Feature Request

If you'd like to make a feature request, please read this section.

The GitHub issue tracker is the preferred channel for library feature requests, but please respect the following restrictions:

  • Please search for existing issues in order to ensure we don't have duplicate bugs/feature requests.
  • Please be respectful and considerate of others when commenting on issues

Submit a Bug Report

A software bug is a demonstrable issue in the code base. In order for us to diagnose the issue and respond as quickly as possible, please add as much detail as possible into your bug report.

Before you decide to create a new issue, please try the following:

  1. Check the Github issues tab if the identified issue has already been reported, if so, please add a +1 to the existing post.
  2. Update to the latest version of this code and check if issue has already been fixed
  3. Copy and fill in the Bug Report Template we have provided below

Improvements to the Codebase

We welcome direct contributions to the health-check code base. Thank you!

Development Environment

Set up your development environment with "go get"

go get github.com/robertoduessmann/health-check

To make sure all the dependencies are installed

dep ensure

git clone https://github.com/robertoduessmann/health-check.git
cd docs

Creating a Pull Request

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/robertoduessmann/health-check
# Navigate to the newly cloned directory
cd docs
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/robertoduessmann/health-check

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout <dev-branch>
git pull upstream <dev-branch>

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely to be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream development branch into your topic branch:

  6. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream master

  7. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  8. Open a Pull Request with a clear title and description against the master branch. All tests must be passing before we will review the PR.

If you have any additional questions, please feel free to create an issue in this repo.