This guide is a work in progress, inspired by http://devguide.python.org/. It is deployed at https://contributor.r-project.org/rdevguide/.
A list of existing resources on R core development that we can use for reference or that we should document in the guide is given in the Wiki for this repo.
Corrections, suggestions and general improvements are welcome as issue submissions.
You can also suggest changes by editing the .Rmd files that are at the root of this repository and submitting a pull request. Please target your pull requests to the main branch.
You can push directly to main for small fixes. Please use PRs to main for discussing larger updates - try to limit to one section or at least one chapter in each PR, so that changes are easier to review.
- Images must be included in the source, not provided as URLs, for the PDF book to compile.
- Images should have alt text for accessibility - note this is shown as a caption in the EPUB version.
Deployment is done via Travis CI:
- whenever there's a push to main, the book is built and its content is put in the
docsdirectory.
If you want to render the guide locally, you need to install bookdown. Then use
bookdown::render_book('index.Rmd', 'bookdown::gitbook')
and the book will be generated in the docs folder. You can open the guide on the command line via open docs/index.html. To preview the PDF or EPUB versions locally, replace 'bookdown::gitbook' with 'bookdown::pdf_book' or 'bookdown::epub_book' as appropriate.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
This book started using Sean Kross' minimal bookdown example as described on their blog.
This README borowed ideas from ropensci/dev_guide.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!