Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 1.17 KB
Raw

Contributing

We love pull requests!

Fork, then clone the repo:

    git clone git@github.com:your-username/mach.git

Set up your machine:

    cd mach
    make build

You can use cobra to create a new feature, but with unit testing it may be easier to dupliate the files already in use:

cobra add <command>

Make sure the existing tests pass:

    make test

While creating new commands, don't forget to create a _test.go file.

Make your changes, Add tests for your change, Make the tests pass:

    make test

Make your change. Add tests for your change. Make the tests pass:

    make test

Push to your fork and submit a pull request.

At this point you're waiting on us. We like to at least comment on pull requests within three business days (and, typically, one business day). We may suggest some changes or improvements or alternatives.

Some things that will increase the chance that your pull request is accepted: