EmojiScreen 📺

A listing of movies, TV shows and musicals depicted through emojis.

Contributing Guidelines 🎁

Below are some additional guidelines to follow when contributing to this project. Follow all of the instructions please. We will just close any pull requests that do not follow instructions.

Adding or Updating Features Contributions

Find an Issue that you would like to complete.
If someone is already assigned an Issue, please move on to another Issue. If the Issue has not been assigned, comment inside of the Issue stating that you would like to work on that item.
Wait for confirmation from the maintainers before working on the Issue.
After you receive confirmation, complete the Issue and submit a Pull Request.

If someone is assigned an Issue and doesn't complete it after a while, we will open the Issue to everyone else again.

If you would like to suggest a new feature, create an Issue and outline what it is you think should be added or updated. Wait for confirmation before working on the Issue.

Adding a Movie, TV show or Musical

To add a show or movie to this project, you will need to add an Emoji Card inside of the data.js file. The data.js file is made up of an array (a list) of objects. You will add a new object for your show.

If you need help choosing a movie or show, check the Issues.

Below is an example of what a show looks like on the website:

In the data.js file, each Emoji Card consists of the following object:

{
  title: "Beauty and the Beast",
  emojiImgs: "🏰🥀🎶📚🕰️",
  genres: ["animation", "family", "fantasy"],
  itemLink: "https://www.imdb.com/title/tt0101414/",
  type: "movie",
  year: 1991
}

Required reading:

View the Card Overview for details on each part of the emoji object.

Walkthroughs

Below are detailed walkthroughs on how to add a show or movie to EmojiScreen.

Add a show or movie via Github website (no downloads required)
Add a show or movie using your local development environment (downloads required, most commonly used way to contribute)

Important Notes

Follow all the instructions in the Card Overview for adding a show or movie.
Search the data.js file and pull requests to make sure you are not adding a duplicate.
Make sure your emojis actually depict the show or movie.
You do not have to wait for confirmation to create a pull request for a show or movie and you do not have to make an Issue first.
If you are adding multiple items, please include them in one pull request.
Go through this checklist to make sure you have added everything needed for a show or movie.
Please fix conflicts if your pull request has them.

Other Projects

Check out my other emoji themed projects.

🎶 EmojiBops: A listing of songs depicted via emojis.

View EmojiBops.com.
View EmojiBops on Github.

📚 EmojiPages: A listing of books depicted via emojis.

View EmojiPages.com.
View EmojiPages on Github.

Git and GitHub Resources

Git Handbook
Additional Git/Github Practice
Visualizing Git Commands Tool
Try creating a new branch for your pull request.
Syncing your Fork

Credits

💖Check out a list of all of the EmojiScreen contributors.

Emoji graphics are by Twitter and are licensed under CC-BY 4.0. Review the Attribution Requirements for more information.

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

faahim / emojiscreen