We're so glad you're thinking about contributing to our opendata.dc-samples
Before contributing, we encourage you to read our CONTRIBUTING guide (you are here), our LICENSE, and our README, all of which should be in this repository. If you have any questions, you can email the DC Data team at [email protected].
The DC Data Team under the management of the Chief Data Officer manages all updates, bugs, and feature additions via GitHub's public issue tracker in this repository.
If you do not already have a GitHub account, you can sign up for GitHub here. Pull requests will be reviewed and accepted. In the spirit of open source software, everyone is encouraged to help improve this project. Here are some ways you can contribute:
- by reporting bugs as issues
- by suggesting new samples
- by adding code for new samples
- by writing or editing documentation
- by closing issues
- Before submitting a new issue, check to make sure a similar issue isn't already open. If one is, contribute to that issue thread with your feedback.
- When submitting a bug report, please try to provide as much detail as possible, i.e. a screenshot or gist that demonstrates the problem, the technology you are using, and any relevant links.
Issues labeled ✨help wanted✨ make it easy for you to find ways you can contribute today.
Our special request is for new samples. We know that we haven't covered the gamut of tools that can turn geojson/json/esri-json into rich and useful data products. We started this repo with the tools and frameworks we know best, but would love to see how you're able to load opendata.dc.gov APIs into your favorite data clients and tools.
Our samples target the new developer, who has some knowledge of popular languages and coding concepts and practices. We want to teach the widest range of users to do the widest range of things possible with our open data platform. So far, we've focused on HTML/javascript and the display of data using the live APIs, but would welcome samples that use python and r to manipulate data in the various download formats (csv, shapefile, kml).
To this end, new samples should:
- demonstrate how to use the data available on opendata.dc.gov
- be contained on a single page (seperate files only for assets like images and supplementary data)
- use simple and concise code that is heavily and helpfully commented
- give proper credit to any inspirations and data sources (ours and others) (this includes basemaps like openstreetmap, and cool samples found in coding blogs)
- follow the overall look-and-feel of the existing samples (where appropriate)
This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. For more information, see LICENSE.md.
All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.
This policy is adapted from Data.gov's policy - thank you, friends