Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/RConsortium/isc-proposal

Boilerplate proposal for R Consortium ISC Proposals
https://github.com/RConsortium/isc-proposal

Last synced: 3 months ago
JSON representation

Boilerplate proposal for R Consortium ISC Proposals

Awesome Lists containing this project

README 

        
# isc-proposal

[![Build Status](https://travis-ci.org/stephlocke/isc-proposal.svg?branch=master)](https://travis-ci.org/stephlocke/isc-proposal)



This repository is a boilerplate repository that helps you prepare your proposal for the [R Consortium](https://www.r-consortium.org).



## Background 

Set up in 2015, the R Consortium is an organisation set up to help support the R Foundation, the R Community, and R users.



> The primary purpose of the R Consortium (collectively, the “Purpose”) is to: 

>

>(a) advance the worldwide promotion of and support for the R open source language and environment as the preferred language for statistical computing and graphics (the “Environment”);

>

>(b) establish, maintain, seek support for, and develop infrastructure projects and technical and infrastructure collaboration initiatives related to the Environment, and such other initiatives as may be appropriate to support, enable and promote the Environment; 

>

>(c) encourage and increase user adoption, involvement with, and contribution to, the Environment; 

>

>(d) facilitate communication and collaboration among users and developers of the Environment, the R Consortium and the R Foundation for Statistical Computing (the “R Foundation”); 

>

>(e) support and maintain policies set by the Board; and 

>

>(f) undertake such other activities as may from time to time be appropriate to further the purposes and achieve the goals set forth above.  

>

>In furtherance of these efforts, the R Consortium shall seek to solicit the participation of all interested parties on a fair, equitable and open basis.

> *[R Consortium Bylaws, Section 1.4](https://bylaws.r-consortium.org)*



Delivery of the technical aspects for R Consortium's projects is overseen by the Infrastructure Steering Committee (ISC). The ISC is set up to receive, select, and manage projects that deliver upon the aims of the Consortium. The ISC will have an ongoing call for proposals and will select proposals to move into project stage approximately every six months. Within the process notes, it does say that if a proposal is unlikely to get funded then the proposers will be notified as soon as possible, partially so that re-submission can happen in the event fixable issues.



## Proposals

Here we detail useful guidance notes on making proposals to the ISC but you should always consult the [ISC Proposal page](https://www.r-consortium.org/about/isc/proposals) as there could be updates.



- Try to complete as many of the sections of this boilerplate document as possible. Each section is included either for practical purposes or has been specifically requested by the ISC

- Add relevant additional sections, like the letter of support from an R Core member if you want a change to R itself

- Proposals should be 2-5 pages when in PDF form

- You *can* submit a proposal on your own, but it's really recommended to get engagement from the community (and the ISC) first

- Proposals should be submitted through this Google form: https://forms.gle/Cuk7pKHabXg9viXWA



## Making your proposal

This is a boilerplate repository that you will need to fork, title appropriately and start filling in.



- Use the github [fork command](https://github.com/stephlocke/isc-proposal#fork-destination-box)

- Go to the repository settings and change the name to reflect your proposal

- Create a new Rstudio project from version control and use the git URL for the repo

- Write an overview of the proposal instead of this boilerplate for the README

- Start completing the relevant Rmd pages of the proposal

- Use `ghgenerate.R` to build the document

- Regularly commit and push the changes to github

- Solicit feedback and contributions from others



### Automatically generate your proposal

You can configure this to produce the needed documents and publish them to the github.io for browsing and posterity. This assumes a reasonable amount of comfort with using Travis-CI but if you're not, please check out my [post on auto-deploying documents](http://itsalocke.com/automated-documentation-hosting-on-github-via-travis-ci/) for background.



- Turn on [Travis-CI](https://travis-ci.org) for the repository

- Add an environment variable called GH_TOKEN to the travis environment, set the value to an OAuth key generated by github to allow "public repo" privileges only

- Amend the `.push_gh_pages.sh` and `ghgenerate.R` with the details of your repository and preferred commit details

- Use the gh-pages branch to host your proposal online and to retrieve the HTML or PDF variants for emailing



## License

Creative Commons Licence
ISC Boilerplate by Stephanie Locke is licensed under a Creative Commons Attribution 4.0 International License.
Based on a work at https://github.com/RConsortium/isc-proposal.