Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 3.26 KB

CONTRIBUTING.md

File metadata and controls

62 lines (38 loc) · 3.26 KB
Raw

Table of contents

How to contribute

Thank you very much for your interest in helping openSNP! We're always happy to see new faces here. To make this a safe and inclusive space there is a code of conduct for the project. To see how to run openSNP in your development environment see INSTALL.md

We do have a Roadmap file to see what we want to achieve over the next weeks and months.

How to submit changes

We accept pull requests via the GitHub interface!

We are using rubocop and Travis-CI. After you have submitted the request, rubocop will complain about any style-breaks (and it always complains) while Travis-CI will run all tests in the background to see whether the pull request broke anything.

Testing

Inside snpr/:

bundle exec rake

This runs RSpec tests as well as the legacy test/unit ones.

What to work on

We do have a Roadmap file to see what we want to achieve over the next weeks and months.

Additionally the issues page has several open issues, some of which are marked as "easy-first-bugs". Some other, general things to work on:

  • Currently we have two different testing environments - the legacy ones in test/unit, and the RSpec tests. It would be great to have all tests inside RSpec.
  • There are many minor style-problems which live in .rubocop_todo.yml inside snpr/.
  • There are some feature ideas floating around in the issues, if you are interested in those please make sure you implement tests for the new features at the same time.

Request enhancements

Open an issue on the issues page, or send a mail to [email protected] so we can get the ball rolling!

Talk to us

You can always open an issue for specific problems, or send a mail to [email protected] if you want to discuss something or if you have any questions or need help with something. There's also [email protected] if something broke on the webpage itself.

We're also available on Twitter:

@gedankenstuecke @helgerausch @philippbayer

There's also a Gitter where you can talk with us.

Last words

Thank you!

Thank you very much for your interest in the project and for the help of all volunteers who've helped us so far! There is a humans.txt where we celebrate all of you!