9210f6793b
* Correct installation documentation * Add stylized titles * Add some changes to the getting started documentation * Add changes for the backend guide * Add changes for the design guide * Add testing / Q&A guide improvements * Minor fixes to contributing docs * More improvements to the general doc * Improvements for frontend guide |
||
|---|---|---|
| .. | ||
| acceptance-tests.md | ||
| code-coverage.md | ||
| codeclimate.md | ||
| integration-tests.md | ||
| preact-tests.md | ||
| readme.md | ||
| skip-ci.md | ||
| unit-functional-tests.md | ||
| title | items | |||||||
|---|---|---|---|---|---|---|---|---|
| Testing / Q&A Guide |
|
We use the following testing tools:
- RSpec for testing the Rails backend
- Capybara with webdrivers for acceptance testing
- guard-rspec for automated testing
- Jest for testing the frontend
- preact-render-spy for testing Preact components
- SimpleCov for tracking overall test coverage on the backend
Each pull request should come with tests related to the newly written feature or bug fix. Ideally, we should test both the frontend and backend.
If you'd like to help us improve our test coverage, we recommend checking out our total coverage and writing tests for selected files based on SimpleCov's test coverage results. You can also check out Code Climate summary which includes the test coverage.
If you're new to writing tests in general or with Rails, we recommend reading about testing with Rails, RSpec, and Capybara first.
Continuous Integration & Continuous Deployment
We are using Travis for CI and CD. Travis will run a build (in an isolated environment for testing) for every push to this repository.
Keep in mind that a passing build does not necessarily mean the project won't run into any issues. Strive to write good tests for the code you wish to contribute.
Travis will deploy your pull request to production after CI passes and a member of the DEV team has approved it.
Our test suite is not perfect and sometimes a re-run is needed.