From 8bdf3eac083915ecae1e94bdab8afcc756441b39 Mon Sep 17 00:00:00 2001 From: Greg Myers Date: Wed, 2 Oct 2019 13:50:56 +0100 Subject: [PATCH] Update the contributing doc, referencing the CI files --- CONTRIBUTING.md | 26 +++++++++++++++++++------- test-app/db/schema.rb | 12 ++++++------ 2 files changed, 25 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 46eb827..f406098 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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/ diff --git a/test-app/db/schema.rb b/test-app/db/schema.rb index 8accba1..e01f8f3 100644 --- a/test-app/db/schema.rb +++ b/test-app/db/schema.rb @@ -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"