Skip to content

Commit

Permalink
Document CONTRIBUTING (#92)
Browse files Browse the repository at this point in the history
To minimize the amount of uncertainty a new contributor feels when
contributing to the project.
  • Loading branch information
teoljungberg authored Mar 10, 2017
1 parent 88b622a commit ea86bdc
Show file tree
Hide file tree
Showing 2 changed files with 64 additions and 6 deletions.
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Contributing

First, thank you for contributing!

We love pull requests from everyone. By participating in this project, you
agree to abide by the thoughtbot [code of conduct].

[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct

Here are a few technical guidelines to follow:

1. Open an [issue][issues] to discuss a new feature.
1. Write tests.
1. Make sure the entire test suite passes locally and on CI.
1. Open a Pull Request.
1. [Squash your commits][squash] after receiving feedback.
1. Party!

[issues]: https://github.com/houndci/hound/issues
[squash]: https://github.com/thoughtbot/guides/tree/master/protocol/git#write-a-feature

## Configure Hound Linters on Your Local Development Environment


After you have cloned this repo, run this setup script to set up your machine
with the necessary dependencies to run and test this app:

```sh
% bin/setup
```
## Linters
### Writing a Linter

See Hound's [CONTRIBUTING] documentation for further details.

[CONTRIBUTING]: https://github.com/houndci/hound/blob/master/CONTRIBUTING.md#writing-a-linter

## Deploying
If you have previously run the `bin/setup` script, you can deploy to staging
and production with:

```sh
% bin/deploy staging
% bin/deploy production
```

## Contributor License Agreement

If you submit a Contribution to this application's source code, you hereby grant
to thoughtbot, inc. a worldwide, royalty-free, exclusive, perpetual and
irrevocable license, with the right to grant or transfer an unlimited number of
non-exclusive licenses or sublicenses to third parties, under the Copyright
covering the Contribution to use the Contribution by all means, including but
not limited to:

* to publish the Contribution,
* to modify the Contribution, to prepare Derivative Works based upon or
containing the Contribution and to combine the Contribution with other
software code,
* to reproduce the Contribution in original or modified form,
* to distribute, to make the Contribution available to the public, display and
publicly perform the Contribution in original or modified form.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,7 @@ This service uses the following linters:
* [credo](https://github.com/rrrene/credo) for Elixir
* [reek](https://github.com/troessner/reek) for Ruby code smells

## Getting Started

After you have cloned this repo, run this setup script to set up your machine
with the necessary dependencies to run and test this app:

% ./bin/setup
To contribute to the Linters codebase, see the [CONTRIBUTING.md] file.

[CONTRIBUTING.md]: CONTRIBUTING.md
[Hound]: https://github.com/houndci/hound

0 comments on commit ea86bdc

Please sign in to comment.