Developer Guide

We'd love it if you can help us develop Dunner and we are glad you thought of reading this developer guide before contributing!

Before working on a pull request please let us know by creating or commenting on an issue on GitHub, and we'd also love to hear from you in our community channel.

How can you help us?

• You can report any issues you found on Github
• Help us improve our Documentation
• Write Dunner recipes that can help others and send us PR on Dunner Cookbook
• Write a blog post on Dunner and it published on our channel
• Help someone get started with Dunner on our discussion forum
• Contribute Code to Dunner! Issues labelled good first issue, help wanted and bug are good to start with.

Pull Requests

• Before creating a PR, always make sure there is a relevant issue for it. If not, create one yourself.
• Make sure to prefix the issue id in commit message titles like, [#1] Mount the source code as a volume to containers where the #1 is the issue id.
• Make all the PRs to develop branch.
• Run make precommit locally before raising PR, this checks for standard Go code styles.

Setup

Makefile is your friend! Have a look at all tasks defined here.

• Install Go. Version 1.13.3+.
• Fork and Clone Dunner
• To install project dependencies, run make setup
• To build project, run make build, on running this command dunner binary file will be created in ~/go/bin
• To run unit tests, run make test

Also, you can create a dunner binary file by running go build in the project directory (go build will automatically compile the main.go program in your current directory generating an executable binary named dunner)**

To run Dunner manually

• Generate executable binary dunner by running go build in the project directory.
• Modify .dunner.yaml(as per your testing requirements)
• Run any dunner command like ./dunner <your command>.%