Skip to content

Commit

Permalink
docs(contrib): lint
Browse files Browse the repository at this point in the history
  • Loading branch information
docwhat committed Oct 26, 2019
1 parent 6e27cbe commit d2cc77f
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
Contributing
============
# Contributing

I love pull requests from everyone!

Getting Started
---------------
## Getting Started

### Install Go

Expand All @@ -16,27 +14,35 @@ If you will be contributing, then you'll want to [fork the repository](https://h

Once you've forked it, then you can clone the source:

git clone git@github.com:<your-username>/<repository-name>.git
```console
git clone git@github.com:<your-username>/<repository-name>.git
```

Fetch the required dependencies:

script/bootstrap
```console
script/bootstrap
```

Before you do any changes, make sure the tests pass:

script/test
script/lint
```console
script/test
script/lint
```

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

script/test
script/lint
```console
script/test
script/lint
```

Push to your fork and [submit a pull request](https://help.github.com/articles/creating-a-pull-request/).

At this point you're waiting on me. I try to be responsive to pull requests, but you know life can get in the way. I may suggest some changes or improvements or alternatives.

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

- Write tests.
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

0 comments on commit d2cc77f

Please sign in to comment.