Skip to content

Latest commit

 

History

History
40 lines (32 loc) · 968 Bytes

CONTRIBUTING.md

File metadata and controls

40 lines (32 loc) · 968 Bytes
Raw

Contributing

  1. Fork and clone this repo
  2. Install dependencies: npm i
  3. Add an accent to english-accents.json
  4. Run the tests to check everything is fine: npm t
  5. Create a Pull Request

Alternatively, create an Issue adding details about the accent.

Adding an accent

An accent entry looks like this:

"arizona": {
  "coords": {
    "lat": 34.304337,
    "lng": -111.614609
  },
  "country": "us",
  "name": "Arizona",
  "videos": ["jusOFxVfjjI", "r2vM04zuO90"]
}

Fields

  • cords: Coordinates in latitude / longitude
  • country: Country id. Options, for now, are these ones (create an issue if you want to add accents for a different country):
    • gb: United Kingdom
    • us: United States
    • ie: Ireland
    • au: Australia
    • nz: New Zealand
  • name: Name of the city / town / place
  • videos: An array of YouTube video ids

A Schema JSON spec is also available here.