POLITICO Interactive News Developer Guide
  • Introduction
  • 🚨BREAK GLASS 🚨
  • Policies
  • Workflow
    • Meeting
    • Starting a project
    • Keeping a budget
    • Pre-Publish
    • Publishing a project
    • Reviewing a project
  • Guides
    • The POLITICO Interactives Build Suite
      • Getting Set Up
      • Starting An Interactive Page
      • Working Within Your Interactive Project
      • Using Components
      • Making Components
      • Getting Data Into Your Interactive
      • Publishing An Interactive
      • Publishing To GitHub
      • Using Aliases
      • Working With Metadata
      • More Templates
    • JS apps style guide
    • 2018 elections apps style
  • Infrastructure
  • WHOIS
  • Tipsheets
    • Onboarding
    • Welcome to the CMS
      • Logging in to the CMS
      • Ask a web producer
      • Place en embed yourself
      • Hide the cube ad on desktop
    • AI2HTML
    • Useful QGIS and Illustrator Hacks
Powered by GitBook
On this page
  • Repository naming conventions
  • Linting
  • READMEs
  • Project management
  1. Guides

2018 elections apps style

Essential conventions for keeping your coworkers sane.

PreviousJS apps style guideNextInfrastructure

Last updated 6 years ago

Repository naming conventions

Generally, back-end projects use existing naming conventions. Front-end projects use the namespace elections-2018.

Lambda front-ends

  • lambda-elections-2018-results

  • lambda-elections-2018-slackchat

Dataviz modules

Should always be scaffolded using the .

Should always follow the pattern of module_elections-2018-*. For example:

  • module_elections-2018-county-choropleth

  • module_elections-2018-census-scatterplot

Civic

Continues to be politico-civic-*.

Linting

Is required. Use in the editor of your choice for JavaScript. Use for Python.

READMEs

Write them with any essential notes.

For dataviz modules, be sure to always update the README with the public API of your module.

Project management

Because issues are the primary way of tracking development in CodeTree, every repo should have at least one issue that is "Push to production."

Will happen in , based on issues in GitHub.

graphics generator
ESLint
Black
CodeTree