diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2830f4f..9945d67 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,13 +10,13 @@ # 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](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) +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/openSNP/snpr/blob/master/CODE_OF_CONDUCT.md). To see how to run openSNP in your development environment see [INSTALL.md](https://github.com/openSNP/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. +We do have a [Roadmap](https://github.com/openSNP/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)! +We accept [pull requests](https://help.github.com/articles/using-pull-requests/) via the [GitHub interface](https://github.com/openSNP/snpr/pull/new/master)! 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. @@ -31,17 +31,17 @@ bundle exec rake This runs RSpec tests as well as the **legacy** test/unit ones. ## What to work on -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. +We do have a [Roadmap](https://github.com/openSNP/snpr/blob/master/ROADMAP.md) file to see what we want to achieve over the next weeks and months. -Additionally the [issues page](https://github.com/gedankenstuecke/snpr/issues) has several open issues, some of which are [marked as "easy-first-bugs"](https://github.com/gedankenstuecke/snpr/issues?q=is%3Aopen+is%3Aissue+label%3Aeasy-first-bugs). Some other, general things to work on: +Additionally the [issues page](https://github.com/openSNP/snpr/issues) has several open issues, some of which are [marked as "easy-first-bugs"](https://github.com/openSNP/snpr/issues?q=is%3Aopen+is%3Aissue+label%3Aeasy-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](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/openSNP/snpr/issues/168). ## Request enhancements -Open an issue on the [issues page](https://github.com/gedankenstuecke/snpr/issues), or send a mail to snpr-development@googlegroups.com so we can get the ball rolling! +Open an issue on the [issues page](https://github.com/openSNP/snpr/issues), or send a mail to snpr-development@googlegroups.com so we can get the ball rolling! ## Talk to us @@ -59,4 +59,4 @@ We're also available on Twitter: ![Thank you!](https://media1.giphy.com/media/10NVUaFVKzbUpW/200.gif) -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](https://github.com/gedankenstuecke/snpr/blob/master/public/humans.txt) where we celebrate all of 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](https://github.com/openSNP/snpr/blob/master/public/humans.txt) where we celebrate all of you! diff --git a/INSTALL.md b/INSTALL.md index 1d99e3f..4cc2202 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,5 +1,5 @@ # Installing openSNP -Hello and thanks so much for your interest in running our code! Maybe even to contribute to the project. For more details on this see [CONTRIBUTING.md](https://github.com/gedankenstuecke/snpr/blob/master/CONTRIBUTING.md) +Hello and thanks so much for your interest in running our code! Maybe even to contribute to the project. For more details on this see [CONTRIBUTING.md](https://github.com/openSNP/snpr/blob/master/CONTRIBUTING.md) ## How the site works @@ -10,7 +10,7 @@ The site itself is based on Ruby on Rails (RoR). We usually try to use the newes git is needed to download the newest sources: ``` -git clone git@github.com:gedankenstuecke/snpr.git +git clone git@github.com:openSNP/snpr.git ``` Afterwards you'll have a new folder called "snpr" (it's not opensnp for historical reasons) in which all the files reside. diff --git a/README.md b/README.md index 8c3e69d..1da4ca9 100644 --- a/README.md +++ b/README.md @@ -12,20 +12,20 @@ according to how many results could be gathered for SNPedia, PLoS and Mendeley on SNPs and Phenotypes. ## Installing openSNP -Please see [INSTALL.md](https://github.com/gedankenstuecke/snpr/blob/master/INSTALL.md) for more detailed instructions on how to run and setup openSNP. +Please see [INSTALL.md](https://github.com/openSNP/snpr/blob/master/INSTALL.md) for more detailed instructions on how to run and setup openSNP. ## Contributing to openSNP -Thanks for your interest in helping us out! You are awesome! Please see [CONTRIBUTING.md](https://github.com/gedankenstuecke/snpr/blob/master/CONTRIBUTING.md) for more detailed instructions on how to contribute. We also [have a ROADMAP.md](https://github.com/gedankenstuecke/snpr/blob/master/ROADMAP.md), containing your idea of where the project should head. +Thanks for your interest in helping us out! You are awesome! Please see [CONTRIBUTING.md](https://github.com/openSNP/snpr/blob/master/CONTRIBUTING.md) for more detailed instructions on how to contribute. We also [have a ROADMAP.md](https://github.com/openSNP/snpr/blob/master/ROADMAP.md), containing your idea of where the project should head. -The project has a [Code of Conduct](https://github.com/gedankenstuecke/snpr/blob/master/CODE_OF_CONDUCT.md) in order to make this a safe and inclusive space for everyone. +The project has a [Code of Conduct](https://github.com/openSNP/snpr/blob/master/CODE_OF_CONDUCT.md) in order to make this a safe and inclusive space for everyone. ## Getting in contact You can always open an issue for specific problems, or send a mail to snpr-development@googlegroups.com if you want to discuss something or if you have any questions or need help with something. There's also info@opensnp.org if something broke on the webpage itself. We're also available on Twitter: -@gedankenstuecke -@helgerausch -@philippbayer +@[gedankenstuecke](https://twitter.com/gedankenstuecke) +@[helgerausch](https://twitter.com/helgerausch) +@[philippbayer](https://twitter.com/philippbayer) [You can also join us on Gitter](https://gitter.im/openSNP/snpr).