Skip to content

Latest commit

 

History

History
38 lines (22 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

38 lines (22 loc) · 1.27 KB
Raw

Contributing to Trestle

Table of Contents

  1. Running the Test Suite
  2. Sandbox Application
  3. Contributor License Agreement

Running the Test Suite

After checking out the repository and installing dependencies by running bundle, the full RSpec test suite can be run with:

$ bundle exec rake

When submitting a pull request, please ensure that all of the tests are passing. Builds will be automatically checked for a passing test suite by GitHub Actions.

Sandbox Application

The Trestle repo includes a sandbox application with some example admins and pages to demo most of the available functionality.

The following commands will set up the database (including sample seed data) and start a rails server:

$ cd sandbox
$ bundle exec rails db:setup
$ bundle exec rails server

You can then browse to http://localhost:3000/admin to access the sandbox.

Contributor License Agreement

We ask that all contributors please sign the Contributor License Agreement. If you have not previously signed the agreement, you will be prompted to when creating your first pull request.