mirror of
https://github.com/ditkrg/rswag.git
synced 2026-01-22 22:06:43 +00:00
Update the contributing doc, referencing the CI files
This commit is contained in:
parent
ed25ff36e6
commit
8bdf3eac08
@ -1,24 +1,36 @@
|
||||
# Contributing
|
||||
|
||||
Fork, then clone the repo:
|
||||
|
||||
## Fork, then clone the repo:
|
||||
```
|
||||
git clone git@github.com:domaindrivendev/rswag.git
|
||||
git clone git@github.com:rswag/rswag.git
|
||||
cd rswag
|
||||
```
|
||||
|
||||
## Build
|
||||
Set up your machine:
|
||||
|
||||
```
|
||||
./ci/build.sh
|
||||
```
|
||||
Or manually
|
||||
```
|
||||
bundle
|
||||
cd spec/dummy
|
||||
cd test-app
|
||||
bundle exec rake db:setup
|
||||
cd -
|
||||
|
||||
cd rswag-ui
|
||||
npm install
|
||||
cd -
|
||||
```
|
||||
|
||||
## Test
|
||||
Make sure the tests pass:
|
||||
|
||||
```
|
||||
./ci/test.sh
|
||||
```
|
||||
or manually
|
||||
```
|
||||
cd test-app
|
||||
bundle exec rspec
|
||||
```
|
||||
|
||||
@ -30,4 +42,4 @@ bundle exec rspec
|
||||
|
||||
Push to your fork and [submit a Pull Request][pr].
|
||||
|
||||
[pr]: https://github.com/domaindrivendev/rswag/compare/
|
||||
[pr]: https://github.com/rswag/rswag/compare/
|
||||
|
||||
@ -2,15 +2,15 @@
|
||||
# of editing this file, please use the migrations feature of Active Record to
|
||||
# incrementally modify your database, and then regenerate this schema definition.
|
||||
#
|
||||
# Note that this schema.rb definition is the authoritative source for your
|
||||
# database schema. If you need to create the application database on another
|
||||
# system, you should be using db:schema:load, not running all the migrations
|
||||
# from scratch. The latter is a flawed and unsustainable approach (the more migrations
|
||||
# you'll amass, the slower it'll run and the greater likelihood for issues).
|
||||
# This file is the source Rails uses to define your schema when running `rails
|
||||
# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
|
||||
# be faster and is potentially less error prone than running all of your
|
||||
# migrations from scratch. Old migrations may fail to apply correctly if those
|
||||
# migrations use external dependencies or application code.
|
||||
#
|
||||
# It's strongly recommended that you check this file into your version control system.
|
||||
|
||||
ActiveRecord::Schema.define(version: 20160218212104) do
|
||||
ActiveRecord::Schema.define(version: 2016_02_18_212104) do
|
||||
|
||||
create_table "blogs", force: :cascade do |t|
|
||||
t.string "title"
|
||||
|
||||
Loading…
Reference in New Issue
Block a user