gunghogeoduck/osem-fcy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add documentation for using ichain in test mode

Browse source 
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.
This commit is contained in:
Aditya Prakash 2016-04-07 11:10:54 +05:30
parent 2d3ea22fd3
commit d770533bdc
3 changed files with 26 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTING.md
View file

@ -10,21 +10,20 @@ In particular, this community seeks the following types of contributions:
# How to contribute # How to contribute
* Prerequisites: familiarity with [GitHub Pull Requests](https://help.github.com/articles/using-pull-requests) and issues. * 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 * 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/)). * 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 tell you! :-) * 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) * 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 * 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 * 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 * Run rubocop locally to check for any ruby style offenses
* https://github.com/openSUSE/osem/wiki/Houndci-and-rubocop * `bundle exec rubocop`
# Conduct # Conduct
OSEM is part of the openSUSE project. We follow all the [openSUSE Guiding OSEM is part of the openSUSE project. We follow all the [openSUSE Guiding
Principles!](http://en.opensuse.org/openSUSE:Guiding_principles) If you think Principles!](http://en.opensuse.org/openSUSE:Guiding_principles) If you think
someone doesn't do that, please let any of the [OSEM someone doesn't do that, please let us know at opensuse-web@opensuse.org.
admins](https://github.com/orgs/openSUSE/teams/osem-admins) know!
# Communication # Communication
GitHub issues are the primary way for communicating about specific proposed GitHub issues are the primary way for communicating about specific proposed

14
INSTALL.md
View file

@ -90,3 +90,17 @@ Open a separate terminal and go into the directory where the rails app is presen
``` ```
rake jobs:work 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"}
```

14
README.md
View file

@ -8,7 +8,7 @@ The Open Source Event Manager. An event management tool tailored to Free and Ope
## Installation and production usage ## Installation and production usage
please refer to [INSTALL](INSTALL.md) documentation file Please refer to [INSTALL](INSTALL.md) documentation file
## Development discipline ## 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 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 * 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 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 * 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 # Issues
please refer to our [CONTRIBUTING guide](CONTRIBUTING.md) Please refer to our [CONTRIBUTING guide](CONTRIBUTING.md)
## Documentation ## 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 bundle exec rdoc --op doc/app --all -f fivefish app
xdg-open doc/app/index.html xdg-open doc/app/index.html
@ -46,9 +46,7 @@ bundle exec guard
This uses [spring](https://github.com/rails/spring) to provide a 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/). [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 Generally, no PR with decreased test coverage should be accepted. Please look closely on status report provided by Coveralls in your PR.
by Coveralls in your PR.
## Style ## Style
We are using [rubocop](https://github.com/bbatsov/rubocop) as a style checker. It is running each time We are using [rubocop](https://github.com/bbatsov/rubocop) as a style checker. It is running each time