ditkrg/rswag
4
0
Fork 0
mirror of https://github.com/ditkrg/rswag.git synced 2026-01-22 22:06:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update the contributing doc, referencing the CI files

Browse Source
This commit is contained in:
Greg Myers 2019-10-02 13:50:56 +01:00
parent ed25ff36e6
commit 8bdf3eac08
2 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
CONTRIBUTING.md
View File

@ -1,24 +1,36 @@
# Contributing # 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 cd rswag
``` ```
## Build
Set up your machine: Set up your machine:
```
./ci/build.sh
```
Or manually
``` ```
bundle bundle
cd spec/dummy cd test-app
bundle exec rake db:setup bundle exec rake db:setup
cd - cd -
cd rswag-ui
npm install
cd -
``` ```
## Test
Make sure the tests pass: Make sure the tests pass:
``` ```
./ci/test.sh
```
or manually
```
cd test-app
bundle exec rspec bundle exec rspec
``` ```
@ -30,4 +42,4 @@ bundle exec rspec
Push to your fork and [submit a Pull Request][pr]. Push to your fork and [submit a Pull Request][pr].
[pr]: https://github.com/domaindrivendev/rswag/compare/ [pr]: https://github.com/rswag/rswag/compare/

12
test-app/db/schema.rb
View File

@ -2,15 +2,15 @@
# of editing this file, please use the migrations feature of Active Record to # of editing this file, please use the migrations feature of Active Record to
# incrementally modify your database, and then regenerate this schema definition. # incrementally modify your database, and then regenerate this schema definition.
# #
# Note that this schema.rb definition is the authoritative source for your # This file is the source Rails uses to define your schema when running `rails
# database schema. If you need to create the application database on another # db:schema:load`. When creating a new database, `rails db:schema:load` tends to
# system, you should be using db:schema:load, not running all the migrations # be faster and is potentially less error prone than running all of your
# from scratch. The latter is a flawed and unsustainable approach (the more migrations # migrations from scratch. Old migrations may fail to apply correctly if those
# you'll amass, the slower it'll run and the greater likelihood for issues). # migrations use external dependencies or application code.
# #
# It's strongly recommended that you check this file into your version control system. # 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| create_table "blogs", force: :cascade do |t|
t.string "title" t.string "title"