Skip to content

Latest commit

 

History

History
25 lines (17 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

25 lines (17 loc) · 1.51 KB
Raw

CONTRIBUTING

Bugs?

Choose a task

Look in the Contributing to charlatan vignette for details if you're adding a new provider or locale. Find one of the open issues labelled with #helpwanted or any other if you want.

Code contributions

Check out the Contributing to charlatan vignette for details if you're adding a new provider or locale.

  • please first open an issue if you want to add something, we can discuss the way forward from there.
  • Fork this repo to your Github account
  • Clone your version on your account down to your machine from your account, e.g,. git clone https://github.com/<yourgithubusername>/charlatan.git
  • Make sure to track progress upstream (i.e., on our version of charlatan at ropensci/charlatan) by doing git remote add upstream https://github.com/ropensci/charlatan.git. Before making changes make sure to pull changes in from upstream by doing either git fetch upstream then merge later or git pull upstream to fetch and merge in one step
  • Make your changes (bonus points for making changes on a new feature branch)
  • Push up to your account
  • Submit a pull request to home base (likely master branch, but check to make sure) at ropensci/charlatan

Community

Also, check out our discussion forum