From d770533bdc0b4d9d1d8e33e785ee846c0536835a Mon Sep 17 00:00:00 2001 From: Aditya Prakash Date: Thu, 7 Apr 2016 11:10:54 +0530 Subject: [PATCH] Add documentation for using ichain in test mode Removed houndp-ci because we are not using it anymore. Removed private links. Ex: [OSEM-admins](https://github.com/orgs/openSUSE/teams/osem-admins) is accessible only to members ot osem-admins team. --- CONTRIBUTING.md | 13 ++++++------- INSTALL.md | 14 ++++++++++++++ README.md | 14 ++++++-------- 3 files changed, 26 insertions(+), 15 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cdb7a08e..7ddf325c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,21 +10,20 @@ In particular, this community seeks the following types of contributions: # 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 (we make use of [hound-ci](https://houndci.com/)). - * Please make sure to mind what travis tell you! :-) + * 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! :-) * 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 (means you're in the [group osem-committers](https://github.com/orgs/openSUSE/teams/osem-committers)) and you get a positive review, you can merge your pull-request yourself + * 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 for fixes according to HoundCI comments - * https://github.com/openSUSE/osem/wiki/Houndci-and-rubocop +* 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 any of the [OSEM -admins](https://github.com/orgs/openSUSE/teams/osem-admins) know! +someone doesn't do that, please let us know at opensuse-web@opensuse.org. # Communication GitHub issues are the primary way for communicating about specific proposed diff --git a/INSTALL.md b/INSTALL.md index e9e031cd..d0f5cad8 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -90,3 +90,17 @@ Open a separate terminal and go into the directory where the rails app is presen ``` rake jobs:work ``` +### Using iChain in test mode +[devise_ichain_authenticatable](https://github.com/openSUSE/devise_ichain_authenticatable) comes with +test mode, which can be useful in development phase in which an iChain proxy is not usually configured or even available. You can enable ichain authentication by setting `CONFIG['authentication']['ichain']['enabled']` equal to `true` in `config.yml` file. You would also need to set following options in `devise.rb`: + +```Ruby +# Activate the test mode +config.ichain_test_mode = true + +# 'testuser' user will be permanently signed in. +config.ichain_force_test_username = "testuser" + +# set email of 'testuser' +config.ichain_force_test_attributes = {:email => "testuser@example.com"} +``` diff --git a/README.md b/README.md index 36ffecfd..667a213c 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The Open Source Event Manager. An event management tool tailored to Free and Ope ## Installation and production usage -please refer to [INSTALL](INSTALL.md) documentation file +Please refer to [INSTALL](INSTALL.md) documentation file ## Development discipline @@ -23,16 +23,16 @@ as fast as we can. There are some things which we embrace * we do planning of next sprint tasks. It is a commitment. We will do our best to deliver what we agreed on * we use [waffle.io](https://waffle.io/opensuse/osem) to track current GH issues/pull requests * what is planned for current sprint is observable in `ready` column (each issue marked with label with same name) -* what is delivered is in done columnt +* what is delivered is in done column * what is in progress lives in respecitive column -* each person assigned in ready column to an issue is acting on his task +* each person assigned in ready column to an issue is acting on their task # Issues -please refer to our [CONTRIBUTING guide](CONTRIBUTING.md) +Please refer to our [CONTRIBUTING guide](CONTRIBUTING.md) ## Documentation -OSEM is extensively (some would say maniacally ;-) documented. You can generate a nice HTML documentation with ''rdoc'' +OSEM is extensively (some would say maniacally ;-) ) documented. You can generate a nice HTML documentation with ''rdoc'' ``` bundle exec rdoc --op doc/app --all -f fivefish app xdg-open doc/app/index.html @@ -46,9 +46,7 @@ bundle exec guard This uses [spring](https://github.com/rails/spring) to provide a [fast feedback loop for the red/green cycle](http://bitzesty.com/blog/2013/05/enable-tdd-with-faster-ruby-on-rails-stack-reloading/). -Generally, no PR with decreased test coverage should be accepted. Please look closely on comments which been provided -by Coveralls in your PR. - +Generally, no PR with decreased test coverage should be accepted. Please look closely on status report provided by Coveralls in your PR. ## Style We are using [rubocop](https://github.com/bbatsov/rubocop) as a style checker. It is running each time