Get Started!

Want to contribute to OSEM?

Here you can find useful information when in development mode.

Read our Contributing Guide

First time?

• When you get involved with OSEM for the first time, you can choose issues labeled as Junior
• Leave a comment on the issue that you want to work on it
  • We expect you to work on it and show progress by either opening a PR or commenting on the issue
  • If you change your mind, and do not want to work on the issue any more, please be fair to others and leave a comment to let us know
  • Do not work on issues that are assigned to others. If you are uncertain, ask and wait for a contributor to reply
• Avoid working on issues that have no label
  • If you have opened a new issue, please wait for a contributor to add relevant labels
• If an issue is a feature, we should first have a rough idea on how we want to implement it
  • If there is already such a discussion on the issue, you can go ahead and pick this up
  • If not, please first leave a comment on how you want to implement it and wait for contributors' feedback

Email Notifications

Note: We use letter_opener in development environment. You can check out your mails by visiting localhost:3000/letter_opener.

Using iChain in test mode

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 OSEM_ICHAIN_ENABLED equal to true in .env file. You would also need to set following options in devise.rb:

# 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 => "[email protected]"}

Using OpenID in developement

OSEM supports OpenID logins via OmniAuth and related provider specific gems. OmniAuth provides the ablity to define per-provider mock accounts for testing. The supported providers are Facebook, Google, openSUSE and GitHub. If you want to use the OSEM provided mock accounts you need to set the appropriate OSEM_PROVIDER_KEY and OSEM_PROVIDER_SECRET environment variables to a non empty string in the .env file.

e.g.

OSEM_GITHUB_KEY='sample'
OSEM_GITHUB_SECRET='sample'

If you don't already have a .env file you can use the dotenv.example as a template.

Review App of your PR

OSEM uses Review Apps on Heroku.

• The review app can be manually created by a maintainer, and when that happens you will see a relevant message in the PR

• Please help reviewers by adding the necessary data relevant to your PR, eg. if your PR is doing something related to conference registrations, go to the review app and make sure there is a conference with registrations.