Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

34 lines (28 loc) · 2.12 KB
Raw

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.
  • copy editing: fix typos, clarify language, and generally improve the quality of the content of OSEM

How to contribute

  • Prerequisites: 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 (we have travis enabled) before you request a pull and that you comply to our ruby styleguide (we make use of hound-ci).
    • Please make sure to mind what travis tell 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) 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

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 any of the OSEM admins know!

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 [email protected] mailinglist, all OSEM contributors are on that list! Additionally you can use #osem channel on freenode IRC.