Skip to content

Commit

Permalink
Merge pull request #265 from openSNP/roadmap
Browse files Browse the repository at this point in the history
idea for the roadmap, see #261
  • Loading branch information
philippbayer committed Mar 4, 2016
2 parents d1abc1d + 400d2a9 commit 9c71d55
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

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](https://github.com/gedankenstuecke/snpr/blob/master/CODE_OF_CONDUCT.md). To see how to run openSNP in your development environment see [INSTALL.md](https://github.com/gedankenstuecke/snpr/blob/master/INSTALL.md)

We do have a [Roadmap](https://github.com/gedankenstuecke/snpr/blob/master/ROADMAP.md) file to see what we want to achieve over the next weeks and months.

## How to submit changes

We accept [pull requests](https://help.github.com/articles/using-pull-requests/) via the [GitHub interface](https://github.com/gedankenstuecke/snpr/pull/new/master)!
Expand All @@ -34,7 +36,7 @@ The [issues page](https://github.com/gedankenstuecke/snpr/issues) has several op

- 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](https://github.com/gedankenstuecke/snpr/issues/168).
- 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](https://github.com/gedankenstuecke/snpr/issues/168).

## Request enhancements

Expand Down
28 changes: 28 additions & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Our Roadmap

Hey, there. Thanks so much for the interest in openSNP and what we're trying to accomplish over the next weeks and months.

We have some ongoing efforts which need to be done as well as some bug fixes and new features we'd love to implement. If you think we should focus on something else: Please just comment, add it or talk to us, whatever you feel like doing!

For each task we list the knowledge needed to solve the task at the end in parenthesis.

## Ongoing Efforts
These are tasks that have no fixed end and that can always be worked on, should always be somewhat on our mind.

* Getting more contributors (that might be you!)
* [Fixing our bad spelling and grammar](https://github.com/openSNP/snpr/issues/239)

## Near future (~1-2 months)
These are issues that should be done rather soon, either because they are urgent or because they can be solved rather easily.
- [ ] [Fitbit-API will break](https://github.com/openSNP/snpr/issues/252) **urgent** We've had Fitbit-support for a couple of years now. But they will change their API, breaking our integration. As it's a valuable data source we should make sure we keep it running. (Required Knowledge: Ruby/Rails gems, APIs, OAuth)
- [ ] [Fix Mediawiki integration](https://github.com/openSNP/snpr/issues/258) We're using an outdated Gem for connecting to the Mediawiki of SNPedia, so that may break in the near future. (Required Knowledge: (Req: Ruby/Rails gems, APIs)
- [ ] [Fix broken autocomplete](https://github.com/openSNP/snpr/issues/223) The UI breaks when entering phenotypes. This makes it harder/more frustrating for people to enter new data. (Required Knowledge: JavaScript)
- [ ] [Fix broken variations not entered](https://github.com/openSNP/snpr/issues/176) Same thing as for the autocomplete. (Required Knowledge: JavaScript)
- [ ] [Overhaul CSS](https://github.com/openSNP/snpr/issues/264) Right now we're using Bootstrap 2 for the CSS, it's outdated and does not play nicely with mobile devices. We should go responsive and allow people to do genetics on their phones. (CSS, JavaScript)

## Long Term (~6 months)
These issues are up next to be worked on! This is a good place to jump in if you want to help with some of our heavier tasks:
- [ ] [Link snps <-> phenotypes](https://github.com/openSNP/snpr/issues/242) So far there is no explicit link of the papers we have for given genetic variants to phenotypes. Which makes it hard for new users to find their way around from genetics to traits and vice versa. Just by linking via keywords found in the papers this could be fixed, drastically improving the usability. (Required Knowledge: Ruby/Rails)
- [ ] [upload files from an url](https://github.com/openSNP/snpr/issues/249) Soon people will have access to full genomes, but uploading this data through a web browser is a pain (it's already hard for the genotypings). So allowing people to enter the download-link which we could use to pull data in would benefit every uploading user. (Required Knowledge: Ruby/Rails, Paperclip gem)
- [ ] [Unify commenting system](https://github.com/openSNP/snpr/issues/143) Our commenting system is rather fragmented, making working on it and using it rather cumbersome, unifying it would make maintaining much easier. (Required Knowledge: Ruby/Rails)
- [ ] [Simplyfing the message system](https://github.com/openSNP/snpr/issues/149) Currently our message system is pretty oldschool. We should take this to the next level, so more users feel like using it. (Required Knowledge: Ruby/Rails)

0 comments on commit 9c71d55

Please sign in to comment.