Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

Latest commit

 

History

History
executable file
·
37 lines (27 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

executable file
·
37 lines (27 loc) · 3.58 KB
Raw

Thanks for your interest in contributing to the 18F Methods! We appreciate all constructive contributions, and we welcome your ideas about how to keep the Methods up-to-date, friendly, and accessible. You can contribute by emailing us, filing an issue, or submitting a pull request.

  • Emailing us. Whether you've got a general question about the Methods, or you'd just like to have a conversation outside of GitHub — whatever the reason, feel free to email us.
  • Filing an issue. See something amiss? Please glance through the existing issues to see if someone has already alerted us to your question or concern before filing a new issue! (Please note that we tag and manage issues using a specific set of labels.)
  • Submitting a pull request. Got a better solution in mind? Please glance through our existing pull requests to see if we're already working on a similar idea before submitting a pull request.
    • Where to submit a pull request: Submit pull requests to the staging branch. This is the main branch of Methods. If you’re not sure how to submit a pull request, feel free to file an issue and we will try to address it ourselves.
    • What to include in a pull request:
      • Changes: a list, preferably bulleted, of what you’re changing
      • Notes: anything that might help us understand the change, like why you’re doing it or alternative approaches you tried
      • Screenshots: if your pull request will affect layout or interaction, to show us what you’re fixing or changing

Before you submit content edits

Please review the Methods content editing checklist. We’re trying to keep the style and structure consistent, so we’ll check contributions against this guide anyway. Might as well check beforehand! If you’d rather just call our attention to something that seems off, go ahead and file an issue and we’ll review the checklist as part of our edits.

Suggesting new Methods

We accept suggestions for additions to the Methods through a Google Form. We use four primary criteria to evaluate all new Method proposals. 18F Methods should be:

  • Aligned: Supports 18F design chapter strategic priorities
  • Tried: It’s been used on one 18F project
  • Succinct how-tos: Think activity, not philosophy
  • Foundational: Context-agnostic and unique
  • For non-experts: Accessible and relevant to a broad audience

For refinements or enhancements to existing Methods, please submit an issue here on GitHub.

Code of conduct

To ensure a welcoming environment for our projects, our staff follows the 18F Code of Conduct; contributors should do the same.

Open source

This project is maintained in accordance with 18F’s Open Source Policy.

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.