Skip to content
This repository has been archived by the owner on May 10, 2022. It is now read-only.

Latest commit

 

History

History
56 lines (32 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

56 lines (32 loc) · 2.7 KB
Raw

Contributing to learngganimate

This outlines how you can contribute to learngganimate.. If you need help with the process please get in touch with one of the team members.

spirit

The spirit of this project is very much we welcome any and all contributions.

During ozunconf18 our process was like a jam session between kind, lovely people who had each picked up an instrument they had either never or barely played before. Accidental art was superfun to share, we'd love if you include your 'missteps'.

Turn off the internal critic/editor voice and jump in.

  • Pick up an issue or add issues

    Sure, we have been trying to add issues as ideas come to us - so if an existing one tickles your fancy #goforit. Not limited to existing issues listed on github by any stretch though. Especially welcome examples of functions we haven't covered yet. Just adding an issue or commenting on an issue is a great contribution on its own.

  • Write a few paragraphs on something you don't understand

    You could write about how you don't understand something (and not produce any animation - I'd love reading things like that). Turn off the internal critic/editor voice and jump in.

  • Add your own example to already existing examples

    You could add your own example to the ones already there. The more the merrier. Different data , different geoms, different pictures - its all great

process

Source Files

The pages themselves we have been creating as R markdown files with the output format of github_document. In the first chunk it's worth turning caching on if you have animations. See the first few lines of some of the other files for examples.

Fixing typos

Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file. These files will generally have the .Rmd extension.

Other Changes

  1. Fork the project to your github account
  2. Clone the repo from your github account to your computer
  3. Have fun creating you contributions
  4. Commit locally often
  5. Push from your machine back to your github account
  6. From your github account create a pull request
  7. Wait for one of the project team to review and accept your pull request
  8. there may occasionally be a need to discuss your changes via comments added to the pull request.
  9. Bask in the glow of success

Bugs

If you’ve found a bug, create an associated issue and illustrate the bug with a minimal reprex.

Code of Conduct

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