Skip to content

Commit

Permalink
Document testing and improve status checks section.
Browse files Browse the repository at this point in the history
  • Loading branch information
hannalaakso committed Oct 26, 2017
1 parent 8e64397 commit 27accbb
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,25 @@ for production use.**
**One place for service teams to find styles, components and patterns for
designing government services.**

## Contribution
## Running tests

### Automated Checks
We are using [RSpec][rspec] for our unit and integration tests. You can run the
tests from command line by running:

When changes are pushed to GitHub [Travis][travis] will attempt to run
the `middleman build` command to ensure that the site can still be generated
correctly.
```
bundle exec rspec
```

[rspec]: https://relishapp.com/rspec

## Automated Checks

When changes are pushed to GitHub [Travis][travis] will:

- run the tests
- run the `middleman build` command to ensure that the site can be generated

If any of these fail, this will be reported in the GitHub status checks
interface.

[travis]: https://travis-ci.org/alphagov/govuk-design-system

0 comments on commit 27accbb

Please sign in to comment.