Skip to content
This repository has been archived by the owner on Jun 13, 2023. It is now read-only.

Latest commit

 

History

History
59 lines (33 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

59 lines (33 loc) · 3.75 KB

Welcome!

We're so glad you're thinking about contributing to this open source project! If you're unsure or afraid of anything, just ask or submit the issue or pull request anyways. The worst that can happen is that you'll be politely asked to change something. We appreciate any sort of contribution, and don't want a wall of rules to get in the way of that.

Before contributing, we encourage you to read LICENSE, and README, all of which are in this repository. If you have any questions, open an issue.

How to contribute copy changes

###Step one Find the copy you want to change on the site. For example, this copy says "ZIP Code" instead of "ZIP code." The latter is AP style, so I want to edit it.

screen shot 2015-08-25 at 10 20 29 am

Then search for that copy in the repository.

screen shot 2015-08-25 at 10 20 52 am

The search results will show you where in the code that content actually sits. Click on the file to open it.

###Step two Click on "Tree:" in the top left corner, and make a new branch that has a descriptive, specific name.

screen shot 2015-08-25 at 10 22 18 am

Then, on the top right of the screen, the edit pen will become clickable. Click the pen to start editing.

screen shot 2015-08-25 at 10 22 56 am

If there's a lot of code, a tip to find the content you want to edit quickly is, for mac users, to press command and F or for PC users, to press control and F. Then type in the specific copy you're looking for, and make your edit right in the code.

screen shot 2015-08-25 at 10 23 21 am

Step three

To save your edits, scroll down to the bottom of the page, and select "commit directly to the [name you just made] branch." Fill out a short description of your edits in the title, more detail in the body, and commit your changes.

screen shot 2015-08-25 at 10 25 43 am

Step four

Then, go up to the top right of the screen and click the button for pull requests.

screen shot 2015-08-25 at 10 26 15 am

Click the "new pull request" button at the top right.

screen shot 2015-08-25 at 10 26 33 am

Review your changes to make sure nothing else was modified. Click on the branch you just created, and then click "create pull request."

screen shot 2015-08-25 at 11 08 05 am

A member of the team will now see you've suggested a change and be able to incorporate it, if appropriate.

Public domain

As a work of the United States Government, this project is in the public domain within the United States. Additionally, the United States Government waives copyright and related rights in this work worldwide through the CC0 1.0 Universal Public Domain Dedication.

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.