Skip to content

Commit

Permalink
Add CONTRIBUTING.md guide
Browse files Browse the repository at this point in the history
  • Loading branch information
spohlenz committed Jul 21, 2021
1 parent 3e7f33c commit 06970b9
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 0 deletions.
38 changes: 38 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing to Trestle

## Table of Contents

1. [Running the Test Suite](#running-the-test-suite)
2. [Sandbox Application](#sandbox-application)
3. [Contributor License Agreement](#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:

```sh
$ 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 [Travis CI](https://travis-ci.com/github/TrestleAdmin/trestle).


## 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:

```sh
$ 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](https://cla-assistant.io/TrestleAdmin/trestle). If you have not previously signed the agreement, you will be prompted to when creating your first pull request.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ The following plugins are currently available:
| *trestle-auth-otp* | 2FA/OTP user authentication | [GitHub](https://github.com/McRipper/trestle-auth-otp) \| [RubyGems](https://rubygems.org/gems/trestle-auth-otp) |


## Development

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for information on developing and contributing to Trestle.


## License

The gem is available as open source under the terms of the [LGPLv3 License](https://opensource.org/licenses/LGPL-3.0).

0 comments on commit 06970b9

Please sign in to comment.