Skip to content

Latest commit

 

History

History
67 lines (35 loc) · 3.62 KB

CONTRIBUTING.md

File metadata and controls

67 lines (35 loc) · 3.62 KB
Raw

Contributing to rockthemes

This outlines how to propose a change to rockthemes.

Submitting a palette

If you want to suggest a palette, please start a new discussion first. I want to keep the number of palettes reasonably manageable, so it might need to be a case of one in, one out.

It would be good if you could link to the cover or already have a draft 4 and 10 colour palette so we can see how the palettes look.

Metal albums tend to go heavy on black, red and white colour scales which don't really appeal, so try to avoid those.

If all is good, then file an issue with the artist, album title and a link to the album cover.

Pull request process

  • Fork the package and clone onto your computer. If you haven't done this before, we recommend using usethis::create_from_github("johnmackintosh/rockthemes", fork = TRUE).

  • Install all development dependences with devtools::install_dev_deps(), and then make sure the package passes R CMD check by running devtools::check(). If R CMD check doesn't pass cleanly, it's a good idea to ask for help before continuing.

  • Create a Git branch for your pull request (PR). We recommend using usethis::pr_init("brief-description-of-change").

  • Changes you will need to make:

  • Add a 4 colour palette to rock_palletes.R

I use canva's online tool, but you are welcome to choose whatever else works for you.

  • Please ensure the new palette name is entered in the correct alphabetical order in both the palette list and the param values.

  • Run devtools::document to update the package documentation

There is a minimal test in the tests/testthat folder Add your palette to that (just copy / paste an existing line and amend to your new palette name). Rerun the tests to ensure it passes (this will pick up errors where a palette is added but not added to the function params)

  • Create a ten colour palette from the image. I used loading.io/ with Count set to 10 (I left all the other options at their default, ticked settings).

  • Add new "album_palette.R" file where you substitute the palette name, using one of the existing ones as a guide. There are 38 instances that will need updating in each palette file. If you are submitting a palette from an artist where one already exists (e.g. there are now 2 Muse themes), please check the existing one and ensure all references to the new palette are different to the existing one.

Update readme (optional)

It's helpful, but not necessary, if you can update the readme, keeping things in alphabetical order where possible (it's tempting to add new palettes to the bottom of each section but this gets confusing very quickly). The readme is rendered via github actions.

  • Make your changes, commit to git, and then create a PR by running usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain Fixes #issue-number.

Code style

  • We use roxygen2, with Markdown syntax, for documentation.

  • We will use testthat for unit tests. Contributions with test cases included are easier to accept.

Code of Conduct

Please note that the rockthemes project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.