Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add scripts to help developers get set up quickly #194

Open
haacked opened this issue Jan 22, 2016 · 0 comments
Open

Add scripts to help developers get set up quickly #194

haacked opened this issue Jan 22, 2016 · 0 comments
Labels

Comments

@haacked
Copy link
Contributor

haacked commented Jan 22, 2016

The installation instructions are really great! However, they encompass a lot of steps and that can dissuade the less intrepid from continuing to get things set up.

At GitHub we have a set of scripts we include in just about every project.

If your scripts are normalized by name across all of your projects, your contributors only need to know the pattern, not a deep knowledge of the application. This means they can jump into a project and make contributions without first learning how to bootstrap the project or how to get its tests to run.

I've seen a lot of OSS projects follow it. You don't have to follow it, but I mention it because it's a nice practice.

For example, it recommends a bootstrap script for installing dependencies. I'd that the Oncoscape ./script/bootstrap script would not only install the dependencies, but also set the environment variables needed to run the app.

For example, in the installation instructions for Windows you have this:

If you'd rather build and install the R packages in a alternate location (such as your home folder), first create a direcotry to hold the packages, then set the "R_LIBS" Windows System environment variable to point at the target folder

and

you'll need to create a directory to store user data and create a new Windows System environment variable named "ONCOSCAPE_USER_DATA_STORE" with a value of file://c:\path\userdata" (replacing the "path" and "userdata" with the correct path and target directory on your system.

I would suggest just having the bootstrap script create subfolders in %LocalAppData\oncoscape such as %LocalAppData%\oncoscape\R-packages and %LocalAppData\oncoscape\userdata and just use those. Here's a case where most developers don't really need to care much about this and having some opinionated defaults goes a long way. If they really care, they can either set this up manually or modify the script.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants