Vignette/template demonstrating how to contribute a new plotting function to bayesplot
Nobody has claimed this yet.
- Dominant language
- R
- Stars
- 442
- Forks
- 93
- Avg merge
- 3h 11m
- Merged PRs (30d)
- 1
Description
Given the increasing number of people developing R packages depending on Stan, it would be nice to have a vignette demonstrating the process of contributing a new plotting function to bayesplot, including the coding (e.g., internally using the available _data functions or making a new one), doc, tests, pull request, etc? Something similar to @tjmahr's blog post but specifically focused on providing a template for new contributors. There are enough packages listing
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the issue's requested scope and the referenced blog post, then inspect bayesplot's existing contributor and vignette documentation. The finished vignette should explain adding a plotting function, including use of available _data functions or creating one, documentation, tests, and the pull request process.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- r
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 32/100