Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
95 lines (62 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

95 lines (62 loc) · 1.96 KB

Contributing to DevBuddy

Quickstart

Install DevBuddy by following the steps in the README.

Clone the project

This will clone a repository from Github: github.com/devbuddy/devbuddy.

The repo will be cloned at ~/src/github.com/devbuddy/devbuddy.

$ bud clone devbuddy/devbuddy

Setup the project with DevBuddy

This is the core feature of DevBuddy, the up command is supposed to prepare/install/setup everything needed to start developing on the project.

~/src/github.com/devbuddy/devbuddy $ bud up

The command will sequentially evaluate the up tasks defined in dev.yml. Some will setup the working environment (go, python), some will install dependencies (golang_dep, pip), some will conditionally execute an arbitrary command for specific situations.

Run the tests

Project specific commands can be defined in the commands section of the dev.yml.

Typical commands are test, lint, clean, release

~/src/github.com/devbuddy/devbuddy $ bud test

Run the linters

~/src/github.com/devbuddy/devbuddy $ bud lint

Run the integration tests

~/src/github.com/devbuddy/devbuddy $ bud integration

Install DevBuddy from your branch

~/src/github.com/devbuddy/devbuddy $ bud install-dev

Reinstall a release

~/src/github.com/devbuddy/devbuddy $ bud install-release

Or simply:

~ $ bud upgrade

Debugging

You can enable the debug messages with:

$ bud-enable-debug

Which is equivalent to:

export BUD_DEBUG=1

Release

Create a release locally with the command:

$ bud release

This command will create a tag and push it to the origin. The CI process will build and upload the distributions on Github.

Updating the version defined in the install.sh script is probably a good idea.