Skip to content

Latest commit

 

History

History
30 lines (15 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

30 lines (15 loc) · 2.4 KB

How to update the handbook

Everyone (both inside and outside 18F) can submit contributions to https://github.com/18F/handbook as a pull request or open an issue with a suggestion. If you're part of 18F, you can also chat about ideas in #18f-handbook or #wg-onboarding.

There is no dedicated staffing for the handbook right now; maintenance is done in spare time by any 18F staff member who is interested in helping.

If you're working on a chunk of writing that is important to you or your team (or to 18F in general), consider asking the 18F Writing Lab to review and edit it before you propose it for the handbook.

If you make a pull request related to a subject that is the responsibility of a specific team or person, please consider tagging or assigning it to that team or person (or pinging them in Slack to ask them to review it).

Each pull request should be reviewed by at least one other 18F staff member before we merge it (in other words, don't merge your own pull requests), as a general good practice.

How to review and merge pull requests

Any 18F staff member can review a pull request and decide whether they feel confident about merging it. If it's not your area of expertise, ask somebody at 18F who has expertise in that area.

For example: if something looks like it's related to how Team Ops works, ask a Team Ops person to review it; if it looks like it needs Infrastructure team review, ask the Infrastructure team.

If you're not sure if you should merge something, ask for a second opinion in #18f-handbook first.

Styles

This will be fleshed out in future iterations. For now, keep in mind that content appearing in the handbook should exemplify best practices with regard to content. Handbook content should be welcoming, personable, and free from jargon.

Public domain

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.

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.