Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 2.37 KB

github_ui_walkthrough.md

File metadata and controls

35 lines (24 loc) · 2.37 KB
Raw

Github Website

This is a walkthrough of how to add an Emoji Card to this project.

This method will use the Github website to contribute to this project. You will not need to download any programs to your computer using these instructions.

  1. Fork this repository. This will create a copy of the repository and create a new repository on your account. Note: the Fork button is located in the top right area of the repo.
  2. Once the repo is forked, you will be taken to the forked repo. Note: In the top left, the name of the repo should now include your username.
  3. Navigate to the data folder in your forked repo and select the correct file (movies.js, musicals.js or tv.js) by clicking on the file name.
  4. Edit the movies.js, musicals.js or tv.js file by clicking on the pencil icon and add a new object for your movie, TV show or musical in alphabetical order. Make sure there is a comma between your object and the object above and below. Refer to the card overview section for requirements for the different object keys.

Use the following object as a template:

{
  title: "Black Panther",
  emojiImgs: "😺🌍🏴💪🏿🦸🏿",
  genres: ["action", "adventure", "sci-fi"],
  itemLink: "https://www.imdb.com/title/tt1825683/",
  type: "movie",
  year: 2018
}
  1. Once you have completed updating the object for your show or movie, scroll to the bottom of the page and add a commit message. The commit message should be formatted like: Added Fight Club or Added Casablanca. Click the Commit Changes button to save your changes.

Screenshot of creating a commit message on the Github website

  1. Navigate to the Pull Request tab. Click on New Pull Request.

Screenshot of a Pull Request on the Github website

  1. Review your changes and then click Create Pull Request. Review the Pull Request checklist to check that you have completed everything for your Emoji Card. Then click on Create Pull Request.
  2. Wait for feedback/review of your Pull Request. Your code will be reviewed and if any changes need to be made, we will let you know. Once your pull request is accepted, you will be able to see your card at https://emojiscreen.com and you will officially have contributed to the project! 🎉