Skip to content

Contributing People Data

Person data is maintained in the openstates/people repository. This repository contains YAML files with all the information on given individuals and committees.

Info

Please note that this portion of the project is in the public domain in the United States with all copyright waived via a CC0 dedication. By contributing you agree to waive all copyright claims.

Checking out

Fork and clone the people repository:

  • Visit https://github.com/openstates/people and click the 'Fork' button.

  • Clone your fork using your tool of choice or the command line:

    $ git clone git@github.com:yourname/people.git
    Cloning into 'people'..
    
  • Build the environment with poetry:

    $ poetry install
    Installing dependencies from lock file
    ...
    
  • And remember to install pre-commit hooks:

    $ pre-commit install
    pre-commit installed at .git/hooks/pre-commit
    

Repository overview

The repository consists of a few key components:

  • settings.yml Settings for state legislatures, including the number of seats, and current vacancies.
  • data/ Data files in YAML format on legislators, organized by state & status.

You can use the os-people and os-committees commands to manage the data:

poetry run os-people --help

or

poetry run os-committees --help

Common tasks

Updating legislator data by hand

Let's say you call a legislator and find out that they have a new phone number, contribute back!

See schema.md for details on the acceptable fields. If you're looking to add a lot of data but unsure where it fits feel free to ask via an issue and we can either amend the schema or make a recommendation.

  1. Start a new branch for this work
  2. Make the edits you need in the appropriate YAML file. Please keep edits to a minimum (e.g. don't re-order fields)
  3. Submit a PR, please describe how you came across this information to expedite review.

Retiring a legislator

  1. Start a new branch for this work
  2. Run poetry run os-people retire with the appropriate legislator file(s)
  3. Review the automatically edited files & submit a PR.

Updating an entire state's legislators via a scrape

Let's say a North Carolina has had an election & it makes sense to re-scrape everything for that state.

  1. Start a new branch for this work
  2. Scrape data using Open States' Scrapers
  3. Run poetry run os-people merge nc scrapes/2021-01-01/001 against the generated JSON data from the scrape
  4. Manually reconcile remaining changes, will often require some retirements as well.
  5. Check that data looks clean with poetry run os-people lint nc --summary and prepare a PR.
Back to top