|
| 1 | +# Contributing to Project Open Data |
| 2 | + |
| 3 | +## How to Contribute |
| 4 | + |
| 5 | +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](faq.md) |
| 6 | + |
| 7 | +Contributions can be made, primarily in two ways: |
| 8 | + |
| 9 | +### Easy |
| 10 | + |
| 11 | +1. Click the "Improve this content" button in the top right corner of any page |
| 12 | +2. Make changes as you would normally |
| 13 | +3. Click "Submit". |
| 14 | +4. You change should appear once approved. |
| 15 | + |
| 16 | +*Note: You may need to [create a free GitHub account](https://github.com/signup/free) if you do not already have one* |
| 17 | + |
| 18 | +### Advanced |
| 19 | + |
| 20 | +1. Configure git by using this [basic tutorial](https://help.github.com/articles/set-up-git) or by downloading the [GitHub for Mac](http://mac.github.com/) (or [GitHub for Windows](http://windows.github.com/)) and optionally [Mou](http://mouapp.com/)1 |
| 21 | +2. [Fork](https://help.github.com/articles/fork-a-repo) the project |
| 22 | +3. Make changes as you would normally using the tools installed in step #1. |
| 23 | +4. Push the changes back to your fork |
| 24 | +5. Submitting a pull request to this repository |
| 25 | +6. You change should appear once approved. |
| 26 | + |
| 27 | +*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.* |
| 28 | + |
| 29 | +## Running Locally |
| 30 | + |
| 31 | +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: |
| 32 | + |
| 33 | +1. `git clone https://github.com/project-open-data/project-open-data.github.com.git && cd project-open-data.github` |
| 34 | +2. `script/bootstrap` |
| 35 | +3. (Make your changes) |
| 36 | +4. `script/server` |
| 37 | +5. Open [localhost:4000](http://localhost:4000) in your favorite web browser |
| 38 | + |
| 39 | +*Note:* You'll need [Ruby](http://www.ruby-lang.org/) and the [Bundler package manager](http://gembundler.com/). |
| 40 | + |
| 41 | +## Licensing |
| 42 | + |
| 43 | +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](readme.md#licensing). |
| 44 | + |
| 45 | +## Privacy |
| 46 | + |
| 47 | +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](readme.md#privacy) for more information. |
0 commit comments