CONTRIBUTING

## Contributing

1. Fork the repo.

2. Run the tests. We only take pull requests with passing tests, and
   it's great to know that you have a clean slate

3. Add a test for your change. Only refactoring and documentation
   changes require no new tests. If you are adding functionality
   or fixing a bug, please add a test.

4. Make the test pass.

5. Open an issue here - https://github.com/katello/generator-bastion/issues/new

6. Ensure commit message begins with 'Fixes #<github_issue_number>'

7. Push to your fork andaa submit a pull request.

## Setup Development Environment

The generator can be setup from git such that as changes are made to the code those changes can be tried in real time.
After you have cloned the git repository, change into the generator's directory and then do a local install.

```
sudo npm install -g yo
cd generator-bastion
sudo npm link
```

The command `yo bastion` should now be globally available on your system.
Finish the setup by installing the dependencies:

```
npm install
```

## Testing

To run the full test suite:

```
grunt mochaTest
```

## Linting

We use (eslint)[eslint.org] to lint our JS files. To run:

```
grunt eslint
```