From 4842055ee69d9043132ff7f6702ed23130de5663 Mon Sep 17 00:00:00 2001 From: andrew morton Date: Tue, 13 Sep 2016 06:43:39 -0600 Subject: [PATCH] Add a contributing file The exact sequence of commands to be able to run the tests wasn't obvious to me so I'm assumiing others could use a hand. I used the factory_girl_rails gem's file as a starting point. --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..618eda5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +Fork, then clone the repo: + +``` +git clone git@github.com:your-username/swagger_rails.git +cd swagger_rails +``` + +Set up your machine: + +``` +bundle +cd spec/dummy +bundle exec rake db:setup +cd - +``` + +Make sure the tests pass: + +``` +bundle exec rspec +``` + +Make your change. Add tests for your change. Make the tests pass: + +``` +bundle exec rspec +``` + +Push to your fork and [submit a pull request][pr]. + +[pr]: https://github.com/domaindrivendev/swagger_rails/compare/