Request for contributions

We are always looking for contributions to OSEM. Read this guide on how to do that.

In particular, this community seeks the following types of contributions:

code: contribute your expertise in an area by helping us expand OSEM
ideas: participate in an issues thread or start your own to have your voice heard.
code editing: fix typos, clarify language, and generally improve the quality of the content of OSEM

Runing OSEM for development

We are using Vagrant to create our development environments.

Install Vagrant and VirtualBox 5.0.10. Both tools support Linux, MacOS and Windows.
Install vagrant-exec:
```
vagrant plugin install vagrant-exec
```

Clone this code repository:

git clone https://github.com/openSUSE/osem.git

Execute Vagrant in the cloned directory:
```
vagrant up
```

Start your OSEM rails app:

vagrant exec /vagrant/bin/rails server -b 0.0.0.0

Check out your OSEM rails app: You can access the app localhost:3000. Whatever you change in your cloned repository will have effect in the development environment. Sign up, the first user will be automatically assigned the admin role.
Changed something? Test your changes!:
```
vagrant exec bundle exec rspec spec
```
Explore the development environment:
```
vagrant ssh
```
Or issue any standard rails/rake/bundler command by prepending vagrant exec
```
vagrant exec bundle exec rake db:migrate
```

How to contribute

Prerequisite: familiarity with GitHub 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

Getting Started

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

Pull Requests workflow

Please open a PR only when you have finished coding, and your changes are ready to be reviewed for merging.

Title
- Include a comprehensive title about what this PR is doing
- Referencing the issue number on the PR title is not giving any information about what this PR is about
Description
- Add a couple of lines about what is the problem you are trying to solve and how you have addressed it
- Add bullet points about the new things you are introducing, if applicable
- Reference the issue
Automated checks
- We automatically run the test suite and security checks on every PR
- Check back later to see if all checks were successful, if not, address them or leave a comment to ask for help
Pushing new changes to your PR
- Always add new commits; this tremendously helps reviewers
- Do not squash commits, unless explicitly requested by the reviewer
Take care of your PR
- Make sure you check the status of your PR regularly
- Address your reviews, make the necessary changes, ask if something is not clear to you
- Rebase against newest changes, when needed, we cannot properly review PRs that are not rebased

Reviewing your PR might take some time, as we are all volunteers. Please be responsive and respectful.

Coding Style

We are using rubocop as a style checker. It is checking code style each time the test suite runs. You can run it locally with

vagrant exec bundle exec rubocop

You can read through current enabled rules in .rubocop.yml file. Explanations of the defined rules can be found in modules Cop::Lint and Cop::Style. Additionally you can read through the ruby style-guide to better understand core principles.

Test Suite

We are using rspec+capybara+factory girl as a test suite. You can run it locally

vagrant exec bundle exec rspec

Code of Conduct

OSEM is part of the openSUSE project. We follow all the 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 mailinglist, all OSEM contributors are on that list! Additionally you can use #osem channel on freenode IRC.

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 => "testuser@example.com"}

7.1 KiB Raw Blame History