Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

31 lines (25 loc) · 1.29 KB
Raw

Contributing

If you want to contribute to this project, here is a quick guide:

  1. Fork the repository
  2. Develop your code changes
  3. Commit your changes
  4. Push to your fork
  5. Submit a pull request

Adding a new map

SVG file

  • Create a new folder /packages/[new-map]/ and a new file /packages/[new-map]/[new-map].svg in kebab-case. For example: /packages/new-zealand/new-zealand.svg
  • Use an appropriate title as aria-label. For example: Map of New Zealand
  • Adjust the viewBox to have no empty space on each side (top, bottom, left, right)
  • Use English names
  • Use semantic ids (shortnames or full names) in kebab-case. For example: ny for New York or taipei-city for Taipei City
  • Use only <svg> and <path> tags (no doctype, external stylesheet, comment...). Other tags will be ignored

JS file

  • Generate the JS file with the npm run build command
  • The /packages/[new-map]/index.js file should be generated. Otherwise it means the SVG file is not valid

Documentation

  • Create a new /packages/[new-map]/README.md file to:
    • list all the locations (states, counties...) alphabetically sorted
    • indicate the credits (source, license...)
    • describe your modifications

Reporting a bug

Open an issue.