CONTRIBUTING.md
In sophiemeakin/technocolour: Colour Palettes Based on Electronic Music Records
Contributing to technocolour
Hi! Thanks for being interested in contributing to technocolour - here's everything you (should) need to get started! 💃🏻🕺🏻
🧑🎨 Adding new colour palettes
You'd like to add a new palette based on your favourite record's artwork? Great! Here's how:
- Find an image of your record e.g. on bandcamp.com and copy the image URL.
- Open it on coolors.co by selecting "Browse image" and pasting the image URL.
- Decide if you're making a qualitative, sequential or diverging colour palette - some images are better suited to one palette type vs. another!
- Create your masterpiece by selecting 6 colours from the image! You can also manually adjust the colours by exporting the palette (select "Export palette", and "Open in the generator").
- Once you've finalised the colours, open an issue with the title "New palette: \<your_palette_name", and include the following information:
- Palette name: one word based on the name of your record.
- Colours: the 6 hex codes of your colour palette.
- Palette URL: a URL to the palette in coolors: from the image picker, select "Export palette", and "Open in the generator".
- Palette metadata: the artist, record and track name.
- Record URL: a URL to bandcamp (or other) where people can also enjoy the record.
- That's it! I'll add the palette to the package as soon as I can. Thank you!
✍️ Fixing typos
If you spot a typo in the package documentation, you can fix it in the source file. The package uses roxygen to automatically build the .Rd files (documentation), so please don't edit these directly!
🐛 Reporting bugs
If something isn't working as it should, please open an issue! Please try to include a reprex with a minimal amount of code to reproduce the bug.
💭 Anything else
If you have ideas for bigger changes, start by opening an issue and we can chat about if and how to move forward!
sophiemeakin/technocolour documentation built on Nov. 1, 2022, 1:21 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Contributing to technocolour
Hi! Thanks for being interested in contributing to technocolour - here's everything you (should) need to get started! 💃🏻🕺🏻
🧑🎨 Adding new colour palettes
You'd like to add a new palette based on your favourite record's artwork? Great! Here's how:
- Find an image of your record e.g. on bandcamp.com and copy the image URL.
- Open it on coolors.co by selecting "Browse image" and pasting the image URL.
- Decide if you're making a qualitative, sequential or diverging colour palette - some images are better suited to one palette type vs. another!
- Create your masterpiece by selecting 6 colours from the image! You can also manually adjust the colours by exporting the palette (select "Export palette", and "Open in the generator").
- Once you've finalised the colours, open an issue with the title "New palette: \<your_palette_name", and include the following information:
- Palette name: one word based on the name of your record.
- Colours: the 6 hex codes of your colour palette.
- Palette URL: a URL to the palette in coolors: from the image picker, select "Export palette", and "Open in the generator".
- Palette metadata: the artist, record and track name.
- Record URL: a URL to bandcamp (or other) where people can also enjoy the record.
- That's it! I'll add the palette to the package as soon as I can. Thank you!
✍️ Fixing typos
If you spot a typo in the package documentation, you can fix it in the source file. The package uses roxygen to automatically build the .Rd files (documentation), so please don't edit these directly!
🐛 Reporting bugs
If something isn't working as it should, please open an issue! Please try to include a reprex with a minimal amount of code to reproduce the bug.
💭 Anything else
If you have ideas for bigger changes, start by opening an issue and we can chat about if and how to move forward!
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.