Skip to content

Latest commit

 

History

History
79 lines (48 loc) · 2.47 KB

contributing.md

File metadata and controls

79 lines (48 loc) · 2.47 KB

Contributing to Bollywood Movie JSON

Follow the steps below:

  • Fork and clone the repo
  • Create a branch with the adds-movie-name
  • Add a json file of the movie with the details below to the appropriate year folder if there isn't one create it please
  • Add a jpeg file of the movie poster to the posters folder using the specifications below
  • Submit PR - if case you want to know how check out this cool doc

Thank you for helping out! :)

A movie has the following details

Movie attribute Details
Release date YYYY-MM-DD release date
Categories action, epic, comedy, drama, family, romance, thriller,
Director Directors of the movie
Writers Screenplay and story writers
Actors Main casts of the movie
Year Movie released year
Runtime Runtime in mins
Songs Songs found in the soundtrack of the film
Storyline Brief description of the movie
Poster Link to img in posters folder same name as movie title

File Example

All files are valid json files: every key should be double-quoted.

The JSON output should be the default "pretty" json output provided by node, with two spaces indent.

When in doubt, the output should match the JSON.stringify(data, null, 2) function output. data being the contents of the json file.

File Names

All filenames should be lower-case. Spaces should be replaced by dashes ("-").

Movies

Each movie should be added to its own year folder and follow the "File Names" rule (above). If the year is not present add it.

Storyline / Description

Should have the "storyline" key and should only be the official one.

Release Date

Should have the "release-date" key on the format "YYYY-MM-DD" in India.

Director / Writer / Actors

The keys are "director" or "writer" or "actors". Note that only the "actors" keys is plural.

If there is only one member, it should be a plain string. Else, it should be an array with strings.

Categories

Always lower-case and singular. Multiple is fine

Year

Just the integer number. No quotes.

Runtime

Length of the movie in minutes. Integer, no quotes.

Songs

Array of strings. Only the sounds on the offical soundtrack

Poster

Add the official poster as a jpeg to the posters folder and link it here

Credits to JSON Movie Collection for helping with this contributing guide.