mog13 / pulp Goto Github PK

There should be something in contributing.md

it should say something along the lines of:

contributions are welcome and encouraged, but please follow these guidelines.
all changes should be in there own branch and submitted with a pull request. The branch should be sensibly named based on the issue its trying to fix.
(more information can be found here: https://guides.github.com/introduction/flow/).
in the pull request comment, please include any issues your pull request is fixing by referencing them like: closes #x. This will close the issue automatically if the pull request is merged.

The readme should have a large title "PULP".

To achieve this you will need to use Markdown, find out how here: https://guides.github.com/features/mastering-markdown/

We need to add more libraries. These libraries should be anything that adds richness to an app or game and no necessary function. If you have an idea for an addition but are unsure then link it in this issue and I will reply whether it would be a good fit or not! (otherwise, you may risk getting your pull request rejected)

use your best judgement for which category it may fit under, but if you think it doesn't fit any feel free to add a new category!

use the following template:

**[libraryname](url to library preferably github)**
overview of library/description

This is an ongoing issue so I will be accepting multiple and ongoing pull requests for it.

We need to add more libraries. These libraries should be anything that adds richness to an app or game and no necessarily core functionality. If you have an idea for an addition but are unsure then link it in this issue and I will reply whether it would be a good fit or not! (otherwise, you may risk getting your pull request rejected)

use your best judgement for which category it may fit under, but if you think it doesn't fit any feel free to add a new category!

use the following template:

**[libraryname](url to library preferably github)**
overview of library/description

This is an ongoing issue so I will be accepting multiple and ongoing pull requests for it.

There should be a basic description of the purpose of the repo in the readme.

This should be something along the lines of:

"Pulp is a list of the best libraries to add some flair to your projects. Its the bounce and ease of animation, the haptic feedback on touch and the ripple on hover. These features are don't provide core functionality to a project but add a level of polish which brings the experience to life."

This should, for now, be plain text. no markdown needed.

There should be a logo below the PULP header.

use this logo:

you will need markdown to do this, to find out how see here: https://guides.github.com/features/mastering-markdown/

There should be subheadings for the list (for now as placeholder).

Add something like:
Animation
Graphics
Sounds
Misc

as subheadings in README.md.

this will require markdown which you can learn about here: https://guides.github.com/features/mastering-markdown/

We need a new markdown file to describe the contributing best practices for the repo. It should be called "CONTRIBUTING.md" and sit at the root of the project.

There should be the following video embedded in the readme:

https://www.youtube.com/watch?v=Fy0aCDmgnxg

now we have the logo we dont really need the main title of PULP

Add a relevant emoji to each side of the category headers

e.g: 🎵Sounds🎵

The title in contribututing.js is broken and renders as #CONTRIBUTING.md

it should instead be a header in markdown reading Contributing (hint #'s need spaces before the title).

here is a resource for markdown:
https://guides.github.com/features/mastering-markdown/

add the library ripple js found here: http://jakiestfu.github.io/Ripple.js/demo/

use the following template and add it under the graphics header

**[libraryname](url to library preferably github)**
overview of library/description

We need to add more libraries. These libraries should be anything that adds richness to an app or game and no necessarily function. If you have an idea for an addition but are unsure then link it in this issue and i will reply whether it would be a good fit or not! (otherwise you may risk getting your pull request rejected)

use your best judgement for which category it may fit under, but if you think it doesn't fit any feel free to add a new category!

use the following template:

**[libraryname](url to library preferably github)**
overview of library/description

This is an ongoing issue so i will be accepting multiple and ongoing pullrequests for it.