From 5770920270050bc8f994d0c2d59e862600db538c Mon Sep 17 00:00:00 2001 From: Henne Vogelsang Date: Tue, 26 Apr 2016 16:25:05 +0200 Subject: [PATCH] Move the not interesting parts down... --- CONTRIBUTING.md | 71 ++++++++++++++++++++++++------------------------- 1 file changed, 35 insertions(+), 36 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4f9a2b9..6a660b10 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,6 @@ We are using [Vagrant](https://www.vagrantup.com/) to create our development env ``` vagrant plugin install vagrant-exec - vagrant plugin install vagrant-reload ``` 3. Clone this code repository: @@ -25,7 +24,7 @@ We are using [Vagrant](https://www.vagrantup.com/) to create our development env git clone https://github.com/openSUSE/osem.git ``` -4. Execute Vagrant: +4. Execute Vagrant in the cloned directory: ``` vagrant up @@ -43,7 +42,7 @@ You can access the app [localhost:3000](http://localhost:3000). Whatever you cha 7. Changed something? Test your changes!: ``` - vagrant exec rspec spec + vagrant exec bundle exec rspec spec ``` 8. Explore the development environment: @@ -55,9 +54,41 @@ You can access the app [localhost:3000](http://localhost:3000). Whatever you cha 9. Or issue any standard `rails`/`rake`/`bundler` command by prepending `vagrant exec` ``` - vagrant exec rake db:migrate + vagrant exec bundle exec rake db:migrate ``` +## How to contribute +* Prerequisite: familiarity with [GitHub Pull Requests](https://help.github.com/articles/using-pull-requests) and issues. +* Fork the repository and make a pull-request with your changes + * Make sure that the test suite passes before you request a pull and that you comply to our ruby styleguide. + * Please increase code coverage by your pull request (coveralls or simplecov locally will give you insight) +* One of the OSEM maintainers will review your pull-request + * If you are already a contributor and you get a positive review, you can merge your pull-request yourself + * If you are not a contributor already please request a merge via the pull-request comments + +### Coding Style +We are using [rubocop](https://github.com/bbatsov/rubocop) as a style checker. It is checking code style each time the test suite runs. You can run it locally with + +```shell +vagrant exec bundle exec rubocop +``` + +You can read through current enabled rules in `.rubocop.yml` file. Explanations of the defined [rules](http://rubydoc.info/github/bbatsov/rubocop/master/frames) can be found in modules [Cop::Lint](http://rubydoc.info/github/bbatsov/rubocop/master/Rubocop/Cop/Lint) and [Cop::Style](http://rubydoc.info/github/bbatsov/rubocop/master/Rubocop/Cop/Style). +Additionally you can read through the [ruby style-guide](https://github.com/bbatsov/ruby-style-guide) to better understand core principles. + +### Test Suite +We are using [rspec](http://rspec.info/)+[capybara](http://jnicklas.github.io/capybara/)+[factory girl](https://github.com/thoughtbot/factory_girl) as a test suite. You can run it locally + +```shell +vagrant exec bundle exec rspec +``` + +## Code of Conduct +OSEM is part of the openSUSE project. We follow all the [openSUSE Guiding Principles!](http://en.opensuse.org/openSUSE:Guiding_principles) If you think someone doesn't do that, please let us know at maintainers@osem.io + +## Contact +GitHub issues are the primary way for communicating about specific proposed changes to this project. If you have other questions feel free to subscribe to the [opensuse-web@opensuse.org](http://lists.opensuse.org/opensuse-web/) mailinglist, all OSEM contributors are on that list! Additionally you can use #osem channel on freenode IRC. + ### Email Notifications **Note**: We use [letter_opener](https://github.com/ryanb/letter_opener) in development environment. You can check out your mails by visiting [localhost:3000/letter_opener](http://localhost:3000/letter_opener). @@ -75,35 +106,3 @@ config.ichain_force_test_username = "testuser" # set email of 'testuser' config.ichain_force_test_attributes = {:email => "testuser@example.com"} ``` - -## How to contribute -* Prerequisite: familiarity with [GitHub Pull Requests](https://help.github.com/articles/using-pull-requests) and issues. -* Fork the repository and make a pull-request with your changes - * Make sure that the test suite passes before you request a pull and that you comply to our ruby styleguide. - * Please increase code coverage by your pull request (coveralls or simplecov locally will give you insight) -* One of the OSEM maintainers will review your pull-request - * If you are already a contributor and you get a positive review, you can merge your pull-request yourself - * If you are not a contributor already please request a merge via the pull-request comments - -### Coding Style -We are using [rubocop](https://github.com/bbatsov/rubocop) as a style checker. It is checking code style each time the test suite runs. You can run it locally with - -```shell -bundle exec rubocop -``` - -You can read through current enabled rules in `.rubocop.yml` file. Explanations of the defined [rules](http://rubydoc.info/github/bbatsov/rubocop/master/frames) can be found in modules [Cop::Lint](http://rubydoc.info/github/bbatsov/rubocop/master/Rubocop/Cop/Lint) and [Cop::Style](http://rubydoc.info/github/bbatsov/rubocop/master/Rubocop/Cop/Style). -Additionally you can read through the [ruby style-guide](https://github.com/bbatsov/ruby-style-guide) to better understand core principles. - -### Test Suite -We are using [rspec](http://rspec.info/)+[capybara](http://jnicklas.github.io/capybara/)+[factory girl](https://github.com/thoughtbot/factory_girl) as a test suite. You can run it locally - -```shell -bundle exec rspec -``` - -## Code of Conduct -OSEM is part of the openSUSE project. We follow all the [openSUSE Guiding Principles!](http://en.opensuse.org/openSUSE:Guiding_principles) If you think someone doesn't do that, please let us know at maintainers@osem.io - -## Contact -GitHub issues are the primary way for communicating about specific proposed changes to this project. If you have other questions feel free to subscribe to the [opensuse-web@opensuse.org](http://lists.opensuse.org/opensuse-web/) mailinglist, all OSEM contributors are on that list! Additionally you can use #osem channel on freenode IRC.