How to contribute

Bug reports and feature requests

If you have suggestions of plots you would like to see in this library and are not currently here, you can open an issue describing your suggestion. No previous knowledge of GitHub is needed to do this. Please read already existing issues to check whether someone else has made the same suggestion or reported the same error before creating a new issue.

Contributing through GitHub

If you have graphs you would like to add to this library and are comfortable using GitHub, fork the repository and submit a pull request to the develop branch with any additions you want to make. Please read the guidelines below about on code, branching and folder structure conventions before opening a pull request.

Contributing via e-mail

If you have graphs you would like to add to this library but you are not comfortable using GitHub, you can send an e-mail to dimeanalytics@worldbank.org. Use the subject "Contribution to R Econ Visual Library" and attach a zipped folder containing (1) the de-identified data used to create the plot, and (2) the code that creates the plots from such data.

Please read the guidelines below on code conventions before sending your contribution. We also recommend that you create a GitHub account and include your GitHub handle in the e-mail so you can receive credit for your contribution.

Contribution guidelines

Code conventions

• We recommend following the tidyverse style guide for all styling relevant to the code submitted.
• R Markdown files are the preferred format for code contributions. You can use our template Markdown file for guidelines on how to organize your script.
• If you have a visualization code in R and are not comfortable using R Markdown or the template file, you can share a common .R script for the visualization.

GitHub conventions

Branches

• Make pull requests to the master branch only if you wish to contribute to README, LICENSE or similar meta data files.
• To contribute with R code files, create a fork from the develop branch and point your pull request back to the same branch.
• If your pull request is related to an open issue , reference the issue in your PR message. If the contribution solves the issue, add the message "Solves issue #X".

Folder structure

• R Markdown files should be saved in the Library folder
• Data files should be saved in Library/Data
• Output figures should be saved in docs/figure
• Rendered HTML files should be saved in docs.

If your are using our template Markdown file , the HTML file and the figures will be automatically saved in the correct folder, as long as the Markdown file is saved in the Library folder. The only adjustment to the template needed for this to use the same name for the Markdown file and for the second code chunk in it .