Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
24 lines (16 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

24 lines (16 loc) · 1.53 KB
Raw

Contributing to localhost

Thanks for helping. This repo is meant for people who are new to open data as much as for people who aren't, so a clear explanation is worth as much as clever code.

Good contributions

  • A new starter. One folder under starters/, one main.py (standard library only, Python 3.9+), and a README.md saying what it does, which source it uses, and how to run it. Keep it small enough to read in five minutes.
  • A dataset note. Found a dataset that's useful, odd or misleading? Explain it in the README's source section, or open an issue.
  • A data problem. Broken download, stale data, a field that doesn't mean what it says. Open an issue with the dataset link and what you saw.
  • Your project in SHOWCASE.md.

Rules for starters

  • Credit the source in the starter's README and in anything it outputs that someone might share (a map, a chart, a page), using the lines in ATTRIBUTION.md.
  • No neighborhood crime rankings, and nothing that turns the 1897 directory into a lookup of individuals. See "Build with care" in the README.
  • No API keys or credentials committed. None of these sources need one.

How to send a change

  1. Fork the repo and make a branch.
  2. Make your change, and run any starter you touched.
  3. Open a pull request saying what you changed and why.

First pull request ever? That's welcome here. Say so in the description and we'll walk through it with you. You can also ask in #build-and-tell on the DEVSA Discord.