Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

47 lines (30 loc) · 2.46 KB
Raw

Contributing to Project Open Data

How to Contribute

This project constitutes a collaborative work ("open source"). Federal employees and members of the public are encouraged to improve the project by contributing. For more information, please see the FAQ

Contributions can be made, primarily in two ways:

Easy

  1. Click the "Improve this content" button in the top right corner of any page
  2. Make changes as you would normally
  3. Click "Submit".
  4. You change should appear once approved.

Note: You may need to create a free GitHub account if you do not already have one

Advanced

  1. Configure git by using this basic tutorial or by downloading the GitHub for Mac (or GitHub for Windows) and optionally Mou1
  2. Fork the project
  3. Make changes as you would normally using the tools installed in step #1.
  4. Push the changes back to your fork
  5. Submitting a pull request to this repository
  6. You change should appear once approved.

Note: All contributors retain the original copyright to their contribution, but by contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the license(s) under which this project is distributed.

Running Locally

Project Open Data runs on GitHub pages and automatically regenerates as a static site after every change. To duplicate this process and preview changes locally:

  1. git clone https://github.com/project-open-data/project-open-data.github.io.git && cd project-open-data.github.io
  2. script/bootstrap
  3. (Make your changes)
  4. script/server
  5. Open localhost:4000 in your favorite web browser

Note: You'll need Ruby and the Bundler package manager.

Licensing

By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the same terms under which the project is licensed.

Privacy

All comments, messages, pull requests, and other submissions received through official White House pages including this GitHub page may be subject to archiving requirements. See the readme for more information.