From 1da40b22cf0deb978e9ca8084ee56ead4270fd9e Mon Sep 17 00:00:00 2001 From: Henne Vogelsang Date: Tue, 26 Apr 2016 14:57:17 +0200 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 38 ++++++++++++++++++++++---------------- 1 file changed, 22 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ddf325c..b23b6d25 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,27 +7,33 @@ In particular, this community seeks the following types of contributions: * ideas: participate in an issues thread or start your own to have your voice heard. * copy editing: fix typos, clarify language, and generally improve the quality of the content of OSEM -# How to contribute +## How to contribute * Prerequisites: 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 (we have [travis](https://travis-ci.org/openSUSE/osem) enabled) before you request a pull and that you comply to our ruby styleguide. - * Please make sure to mind what travis tells you! :-) + * 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 -* Run rubocop locally to check for any ruby style offenses - * `bundle exec rubocop` -# 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 opensuse-web@opensuse.org. +### 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 -# Communication -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. +```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.