From b400a95476d3075529181f4e391cea3597abb7b4 Mon Sep 17 00:00:00 2001 From: Henne Vogelsang Date: Fri, 25 Apr 2014 18:13:20 +0200 Subject: [PATCH] Put the contribution guide into CONTRIBUTING.md --- CONTRIBUTING.md | 29 +++++++++++++++++++++++++++++ README.md | 11 +---------- 2 files changed, 30 insertions(+), 10 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..0beaa5cb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,29 @@ +# 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](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 and hound tell you! :-) +* 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 not a contributor already please request a merge via the pull-request comments + +# 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! + +# 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 [opensuse-web@opensuse.org](http://lists.opensuse.org/opensuse-web/) +mailinglist, all OSEM contributors are on that list! diff --git a/README.md b/README.md index f74e3ee6..e0dd0fdf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![Build Status](https://travis-ci.org/openSUSE/osem.svg?branch=master)](https://travis-ci.org/openSUSE/osem) [![Code Climate](https://codeclimate.com/github/openSUSE/osem.png)](https://codeclimate.com/github/openSUSE/osem) [![Coverage Status](https://coveralls.io/repos/openSUSE/osem/badge.png)](https://coveralls.io/r/openSUSE/osem) +[![Security Status](https://hakiri.io/github/openSUSE/osem/master.svg)](https://hakiri.io/github/openSUSE/osem/master) #OSEM The Open Source Event Manager. An event management tool tailored to Free and Open Source Software conferences. @@ -54,13 +55,3 @@ We are using [rspec](http://rspec.info/)+[capybara](http://jnicklas.github.io/ca ``` bundle exec rake rspec ``` - -## Contributing -We are always looking for contributions to OSEM. Here is how you can: - -* 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](https://houndci.com/)). - * Please make sure to mind what travis and hound tell you! :-) -* 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 not a contributor already please request a merge via the pull-request comments