sckott / cowsay

cowsay w/ more animals, in R
https://sckott.github.io/cowsay/
Other
310 stars 49 forks source link

Contributing: add guidelines for whats in/out of scope #64

Closed sckott closed 6 years ago

sckott commented 6 years ago

add to https://github.com/sckott/cowsay/blob/master/CONTRIBUTING.md and perhaps README as well to make sure people see it

cc @aedobbyn

sckott commented 6 years ago

---------- DRAFT ----------

to add to CONTRIBUTING.md

Scope

We're looking for ASCII art that can be recognized immediately. So we'd like to stay away from ASCII art that where it's hard to tell what the thing is. Ask yourself, would most R users know what the thing is? If not, it may be useful to make the art more detailed or consider using a different piece of art. Exceptions on a case by case basis.

Out of scope:

Size:

Art must be no bigger than the following three examples: hypnotoad, shark, bat2

Not sure about scope:

Before opening a pull request, it's a good idea to open an issue to check if your idea is in scope.

DIY

We could alter the package to allow people to use their own ASCII art. Ths would be a nice path for when something is out of scope. If this is done, add some text to contributing.md about this.

sckott commented 6 years ago

fixed in 54d5760