Skip to content

Latest commit

 

History

History
82 lines (47 loc) · 6.56 KB

CONTRIBUTING.md

File metadata and controls

82 lines (47 loc) · 6.56 KB
Raw

Welcome!

We're so glad you're thinking about contributing to an FPAC open source project! If you're unsure about anything, just ask — submit your issue or pull request anyway. The worst that can happen is we'll politely ask you to change something. We appreciate all friendly contributions, whether they be from FPAC collaborators or citizens alike.

One of our goals is to ensure a welcoming environment for all contributors to our projects. Our staff follows the USDA Employee Responsibilities and Conduct, and all contributors should do the same.

Guidelines

Submitting an issue

To help us get a better understanding of the issue you're submitting, follow our ISSUE TEMPLATE and the guidelines it describes.

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 a member of the USDA-FSA GitHub Organization). Read more about forking a GitHub repository.
  3. Create a branch that lightly defines what you're working on (for example, proposed-foo-styles).
  4. Ensure that your contribution works via npm, if applicable. See below under Install the package locally via npm-link.
  5. Once you're ready to submit a pull request, fill out the PULL REQUEST template provided.
  6. Submit your pull request against the gh-pages-dev branch.

Building fsa-style locally with Grunt

The Design System's fsa-style package (the ZIP download or contents of published NPM module) and Design System website (our public site that displays examples of each component and the HTML code) are built using Grunt automation. To use Grunt, first make sure you've installed it on your machine globally.

npm install --global grunt-cli

Then, to start, run the following command to install any new dependencies and run the default Grunt task:

npm start

Licenses and attribution

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

The Source Sans Pro font files in assets/fonts are a customized subset of Source Sans Pro, licensed under the SIL Open Font License, and copyright 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 font files in assets/fonts are from Google Web Fonts, licensed under the SIL Open Font License, and copyright 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 thoughtbot, inc., under the MIT license.

The files in assets/_scss/lib/neat are from Neat, copyright 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 Zach Leatherman, under the MIT license.

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

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

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

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

The file assets/js/vendor/selectivizr-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 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.