Skip to content

Latest commit

 

History

History
35 lines (18 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

35 lines (18 loc) · 1.8 KB

Contributing to Deployadactyl

Deployadactyl is an open source project and we welcome all contributions!

Requirements

If this is your first contribution we require you to sign our Contributing License Agreement.

Note: Do not make commits through the GitHub web interface due to issues with the automated CLA management.

Ensure tests have been added for your changes. If you need help writing tests, send us a pull request with your changes and we will help you out. We use Ginkgo and Gomega to write our tests using behavior driven development.

Requesting Features

Make an issue

Making changes

Following these steps will help you get your pull request accepted:

  • Fork Deployadactyl. Pull and checkout to the develop branch to ensure you have the latest commits

  • Create a topic branch where you want to base your work: git checkout -b fix_some_issue

  • Ensure your code follows Go best practices found at Effective Go and Go Code Review Comments

  • Use git rebase (not git merge) to sync your work with the latest version: git fetch upstream && git rebase upstream/master

  • Run all the tests to assure nothing else is broken: ginkgo -r or go test ./...

  • Create a pull request against the develop branch

  • Run go fmt ./...

  • Ensure all pull request checks (such as continuous integration) pass