Skip to content

Latest commit

 

History

History
89 lines (51 loc) · 6.06 KB

CONTRIBUTING.md

File metadata and controls

89 lines (51 loc) · 6.06 KB
Raw

Welcome!

We're so glad you're thinking about contributing to an 18F open source project! If you're unsure about anything, just ask — or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We appreciate all friendly contributions.

We want to ensure a welcoming environment for all of our projects. Our staff follows the 18F Code of Conduct and all contributors should do the same.

We encourage you to read this project's CONTRIBUTING policy (you are here), its LICENSE, and its README.

If you have any questions or want to read more, check out the 18F Open Source Policy GitHub repository, or just shoot us an email.

Guidelines

Submitting an issue

To help us get a better understanding of the issue you are submitting, please leverage the following outline (as used in the following Girl Develop It issue template):

Description

Include a high-level description of the feature or error here including steps of how to recreate it if applicable. Include any benefits, challenges, or considerations. This can be short and sweet.

Ask

Describe the desired behavior and what would deem this issue, bug, or feature complete.

To Do

  • Steps
  • To
  • Complete/Fix

Additional Info

Include any images, steps to recreate, notes, emojis, or whatever.

Submitting a pull request

Here are a few guidelines to follow when submitting a pull request:

  1. Create a GitHub account or sign in to your existing account.
  2. Fork this repo into your GitHub account (or just clone it if you're an 18F team member). Read more about forking a repo here on GitHub: https://help.github.com/articles/fork-a-repo/
  3. Create a branch that lightly defines what you're working on (e.g. add-styles).
  4. Once you're ready to submit a pull request, push your branch up to the repo.
  5. Submit your pull request against the 18f-pages-staging branch.

Questions or need help with setup? Feel free to open an issue here https://github.com/18F/web-design-standards/issues.

Licenses and attribution

A few parts of this project are not in the public domain

The font files in assets/fonts are from Google Web Fonts, licensed under the SIL Open Font License.

  • The Source Sans Pro fonts are copyright 2010, 2012 Adobe Systems Incorporated, with Reserved Font Name 'Source'. All Rights Reserved. Source is a trademark of Adobe Systems Incorporated in the United States and/or other countries.

  • The Merriweather fonts are copyright © 2010-2013, Sorkin Type Co with Reserved Font Name 'Merriweather'.

The files in assets/img are from Font Awesome by Dave Gandy under the SIL Open Font License 1.1.

The files in assets/_scss/lib/bourbon are from Bourbon, copyright © 2011–2015 thoughtbot, inc., under the MIT license.

The files in assets/_scss/lib/neat are from Neat, copyright © 2012–2015 thoughtbot, inc., also under the MIT license.

The file assets/css/normalize.min.css is from Normalize.css, copyright © Nicolas Gallagher and Jonathan Neal, under the MIT license.

The file assets/js/component.js includes politespace.js from Politespace, copyright © 2013 Zach Leatherman, under the MIT license.

The file assets/js/vendor/html5shiv.js is from HTML5 Shiv, copyright © 2014 Alexander Farkas (aFarkas), under the MIT license.

The file assets/js/vendor/jquery-1.11.3.min.js is from jQuery, copyright © 2015 The jQuery Foundation, under the MIT license.

The file assets/js/vendor/rem.min.js is from REM unit polyfill, copyright © 2015 Chuck Carpenter, under the MIT license.

The file assets/js/vendor/respond.js is from Respond.js, copyright © 2012 Scott Jehl, under the MIT license.

The file assets/js/vendor/selectivisr-min.js is from Selectivizr, copyright © Keith Clark, under the MIT license.

The files assets-styleguide/js/vendor/prism.js and assets-styleguide/css/prism.css are from Prism, copyright © 2012-2013 Lea Verou, under the MIT license.

The rest of this project is in the public domain

The rest of this project is in the worldwide 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.