Skip to content

Latest commit

 

History

History
40 lines (29 loc) · 2.7 KB

contribute.md

File metadata and controls

40 lines (29 loc) · 2.7 KB

Contribution Guide

Image assets

  • SVG is preferred over JPG, PNG, SVG is recommended to be optimized through SVGO.
  • When PNG is used, it is recommended to use a PNG compresser such as TinyPNG. (There is cli version of it too!)
  • Image assets that were replaced by datauri are going into src/image-assets/

Accessiblity

  • Users should be able to navigate the page only with keyboard.
  • Outlines of input forms shouldn't be disabled.

Who are using Styleguide?

Are you working with other Mapzen-related repo?

  • When changes should happen across the repos, it is important to make each change not depending on each other. We recommend contributors to follow the steps below.

Pre-requirement

  • Make an issue with checklist via this link. Make the future issues and pr related to the task link to the issue.
  • Add temporary css or javascript on the branch of the repo which needs a change.
  • Share changes with other people using Precog.

requirement

  • Add new features on styleguide.
  • Reflect changes needed to the other repo you are working on.
  • Get rid of old features not used any more on Styleguide.