v1.0.0-alpha.9

Merge pull request #53 from CMSgov/staging

.eslintrc

@@ -29,6 +29,7 @@
     "jest/no-disabled-tests": "warn",
     "jest/no-focused-tests": "error",
     "jest/no-identical-title": "error",
+    "jest/valid-expect": "error",
     "no-unused-vars": ["error", {ignoreRestSiblings: true}],
     "sort-imports": "error",
     "react/forbid-prop-types": "error",

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,17 @@
+## Description
+
+Include a high-level description of the issue or feature. What did you expect to happen? What happened instead? What would you like to see changed?
+
+Include any benefits, challenges, or considerations. This can be short and sweet.
+
+## Steps to reproduce the issue
+
+1. Step one
+2. Step two
+
+## Additional information [optional]
+
+- Relevant research and support documents
+- Screenshots
+- Notes
+- And so on

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,16 @@
+Please follow the format below. Feel free to remove any sections that aren't relevant.
+
+### Added
+List new features or components. Include a screenshot for new visual elements.
+
+### Changed
+List changes in existing functionality or design. If the change was visual, include a comparison screenshot showing the before and after the visual change.
+
+### Deprecated
+List once-stable features or components to be deprecated in this PR.
+
+### Removed
+List deprecated features or components removed in this PR.
+
+### Fixed
+List any bug fixes.

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -1,3 +1,18 @@
+## Welcome!
+
+We're excited you're considering contributing to our design system. If you have a question, noticed a bug, or have suggestions, then please submit an issue or create a pull request.
+
+One of our goals is to ensure a welcoming environment for all contibutors. Please take a look at our [Code of Conduct](https://github.com/CMSgov/design-system/blob/master/CODE_OF_CONDUCT.md) to learn more.
+
+Below you'll find information on how to setup a local development environment and how to contribute code to the design system.
+
+In **[our Wiki](https://github.com/CMSgov/design-system/wiki)** you can find additional information like:
+
+- Coding guidelines
+- Guiding principles
+- How to write documentation
+- etc.
+
 ## Running locally
 
 This project uses [Yarn](https://yarnpkg.com/) for package management. Yarn helps ensure everyone is using the same package versions. If you've used NPM before, you'll have no trouble using Yarn.
@@ -15,25 +30,32 @@ _Note_: `yerna` will become obsolete once [Lerna](https://lernajs.io/) [is merge
 
 ### Scripts
 
-Additional scripts exist and can all be run from the root level of the repo:
-
-- `yarn run start` - You'll want to run this when you're developing components. It compiles Sass, transpiles JavaScript, and runs a local documentation instance where you can preview changes.
-- `yarn run build` - compile/transpile/uglify everything and makes things release-ready.
-- `yarn run bump` - increments package versions. Read "[Versioning](https://github.com/CMSgov/design-system/wiki/Versioning)" for more info.
-- `yarn run generate` - Generates the necessary files for a new core component
-  - `yarn run g` - Alias for `yarn run generate`
-- `yarn test` - tests and lints the codebase.
-
-## Development process
-
-1. Branch off of `staging`: `git checkout -b username/branch-name`.
-1. Commit your changes
-1. Make a pull request against the `staging` branch and format your pull request description using the following format:
-  - **Added:** for new features or components. _Include a screenshot for new visual elements._
-  - **Changed:** for changes in existing functionality or design. If the change was visual, _include a comparison screenshot showing the before and after the visual change._
-  - **Deprecated:** for once-stable features or components removed in upcoming releases.
-  - **Removed:** for deprecated features or components removed in this release.
-  - **Fixed:** for any bug fixes.
+These scripts can all be run from the root level of the repo:
+
+- `yarn run start`
+  - Starts local server running the documentation site
+  - Regenerates documentation when files change
+- `yarn run build`
+  - Compile/transpile/uglify everything and makes things release-ready.
+- `yarn run bump`
+  - Increments package versions. Read "[Versioning](https://github.com/CMSgov/design-system/wiki/Versioning)" for more info.
+- `yarn run generate`
+  - Generates the necessary files for a new core component
+  - Alias: `yarn run g`
+- `yarn test`
+  - Runs JS unit tests
+  - Lints JS using ESLint
+  - Lints Sass using stylelint
+- `yarn run test:watch`
+  - Runs JS unit tests and will continue to run tests as files change
+
+## Submitting a pull request
+
+Here are a few guidelines to follow when submitting a pull request:
+
+- Branch off of `staging`: `git checkout -b username/branch-name`
+- Commit your changes
+- Make a pull request against the `staging` branch
 
 ## Merging pull requests
 
@@ -45,11 +67,22 @@ Use the "**Squash and merge**" option when merging pull requests into the `stagi
 
 Use the "**Create a merge commit**" option when merging `staging` into `master`. If the pull request includes a version bump, set the commit title to the version number and include the PR # in the commit description.
 
-## Additional guidelines
+## Licenses and attribution
 
-**[Please view the Wiki](https://github.com/CMSgov/design-system/wiki)** for additional information like:
+### A few parts of this project are not in the public domain
 
-- Coding guidelines
-- Guiding principles
-- How to write documentation
-- etc.
+For complete attribution and licensing information for parts of the project that are not in the public domain, see `LICENSE.md`.
+
+### 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](https://creativecommons.org/publicdomain/zero/1.0/).
+
+### Contributions will be released into the public domain
+
+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.

LICENSE.md

@@ -0,0 +1,61 @@
+## A few parts of this project are not in the public domain
+
+### Files licensed under the Apache license
+
+The Open Sans font files are from [Google Web Fonts](https://fonts.google.com/specimen/Bitter), licensed under the [Apache License](http://www.apache.org/licenses/LICENSE-2.0).
+
+### Files licensed under the SIL Open Font License
+
+The Bitter font files are from [Google Web Fonts](https://fonts.google.com/specimen/Bitter), licensed under the [SIL Open Font License](http://scripts.sil.org/cms/scripts/page.php?item_id=OFL), and copyright [Sol Matas](www.huertatipografica.com.ar), with Reserved Font Name "Bitter"
+
+The icons in `core/src/images` are from [Font Awesome](http://fontawesome.io/) by Dave Gandy under the [SIL Open Font License 1.1](http://scripts.sil.org/OFL).
+
+### Files licensed under the MIT license
+
+- [Bourbon](http://bourbon.io/), copyright [thoughtbot](https://thoughtbot.com/), inc., under the [MIT license](https://github.com/thoughtbot/neat/blob/master/LICENSE.md).
+- [kss-node](https://github.com/kss-node/kss-node), copyright Hugh Kennedy, John Albin Wilkins, et. al.
+
+#### Full license text for the MIT licensed files:
+
+```
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```
+
+### Other files
+
+Files listed in the `package.json` files and installed via NPM are externally
+maintained libraries used by this software which have their own
+licenses; we recommend you read them, as their terms may differ from the
+terms listed here.
+
+## The rest of this project is in the worldwide public domain
+
+This project is in the public domain within the United States.
+
+Additionally, we waive copyright and related rights in the work worldwide through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+
+### CC0 1.0 Universal Summary
+
+This is a human-readable summary of the [Legal Code (read the full text)](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
+
+#### No Copyright
+
+The person who associated a work with this deed has dedicated the work to the public domain by waiving all of his or her rights to the work worldwide under copyright law, including all related and neighboring rights, to the extent allowed by law.
+
+You can copy, modify, distribute and perform the work, even for commercial purposes, all without asking permission.
+
+#### Other Information
+
+In no way are the patent or trademark rights of any person affected by CC0, nor are the rights that other persons may have in the work or in how the work is used, such as publicity or privacy rights.
+
+Unless expressly stated otherwise, the person who associated a work with this deed makes no warranties about the work, and disclaims liability for all uses of the work, to the fullest extent permitted by applicable law. When using or citing the work, you should not imply endorsement by the author or the affirmer.
+
+### Contributions to this project
+
+As stated in [CONTRIBUTING](CONTRIBUTING.md), 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.

README.md

@@ -1,11 +1,26 @@
 # CMSGov Design System
 
-## Packages
+> A shared set of design and development resources for creating accessible and consistent websites. The design system includes things like principles, high-level guidelines (UX conventions, UI code conventions, etc), UI components, documentation, tools, resources, and more.
 
-This repo contains multile projects in the `packages` directory. View the README in each individual package for more information on each one.
+You're currently at the root of a monorepo which contains multiple projects in the `packages` directory. The root of this project has code related to the development and build process, so it's probably not that useful to you unless you're a contributor.
 
-- [core](packages/core/) - Core CSS and React components
-- [docs](packages/docs/) - The documentation website
+**This repo includes the following. View the README in each of these for more details.**
+
+### [Core NPM package](packages/core/)
+
+This package directory contains the core CSS and React components for the design system. This is the code most people using the design system will interact with.
+
+### [Documentation site](packages/docs/)
+
+This directory contains code related to the documentation website. Unless you're a contributor, this directory isn't that interesting to you.
+
+### [Yeoman generator](packages/generator-cmsgov/)
+
+A [Yeoman](http://yeoman.io/) generator used in the development process. Again, unless you're a contributor, this directory isn't that interesting to you.
+
+## Examples
+
+Examples of the design system in use can be found in the [`examples` directory](tree/master/examples).
 
 ## Contributing
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "design-system",
   "private": true,
-  "description": "Styleguide and React component library",
+  "description": "A shared set of design and code elements for creating accessible and consistent websites",
   "repository": "CMSgov/design-system",
   "scripts": {
     "bootstrap:yarn": "yerna install",
@@ -15,16 +15,16 @@
     "test:watch": "NODE_ENV=test jest --watch"
   },
   "devDependencies": {
-    "autoprefixer": "^6.7.7",
+    "autoprefixer": "^7.1.0",
     "babel-core": "^6.24.1",
-    "babel-jest": "^19.0.0",
-    "babel-loader": "^6.4.1",
+    "babel-jest": "^20.0.3",
+    "babel-loader": "^7.0.0",
     "babel-polyfill": "^6.22.0",
     "babel-preset-es2015": "^6.24.1",
     "babel-preset-react": "^6.24.1",
     "babel-preset-stage-3": "^6.24.1",
     "babel-register": "^6.24.1",
-    "browser-sync": "^2.18.8",
+    "browser-sync": "^2.18.11",
     "bytes": "^2.5.0",
     "cli-table": "^0.3.1",
     "colors": "^1.1.2",
@@ -36,59 +36,59 @@
     "eslint": "^3.19.0",
     "eslint-config-nava": "^1.0.0",
     "eslint-plugin-filenames": "^1.2.0",
-    "eslint-plugin-jest": "^19.0.1",
-    "eslint-plugin-jsx-a11y": "^4.0.0",
-    "eslint-plugin-react": "^6.10.3",
+    "eslint-plugin-jest": "^20.0.3",
+    "eslint-plugin-jsx-a11y": "^5.0.3",
+    "eslint-plugin-react": "^7.0.1",
     "front-matter": "^2.1.2",
     "generator-cmsgov": "file:./packages/generator-cmsgov",
     "gulp": "^3.9.1",
     "gulp-babel": "^6.1.2",
     "gulp-bump": "^2.7.0",
-    "gulp-changed": "^2.0.0",
+    "gulp-changed": "^3.1.0",
     "gulp-changed-in-place": "^2.2.0",
     "gulp-count": "^0.3.0",
     "gulp-eslint": "^3.0.1",
     "gulp-if": "^2.0.2",
     "gulp-merge-json": "^1.0.0",
-    "gulp-postcss": "^6.4.0",
+    "gulp-postcss": "^7.0.0",
     "gulp-sass": "^3.1.0",
     "gulp-sourcemaps": "^2.6.0",
     "gulp-string-replace": "^0.4.0",
     "gulp-stylelint": "^3.9.0",
     "gulp-util": "^3.0.8",
-    "jest": "^19.0.2",
+    "jest": "^20.0.3",
     "kss": "^3.0.0-beta.18",
-    "lerna": "^2.0.0-rc.3",
+    "lerna": "^2.0.0-rc.4",
     "lodash": "^4.17.4",
     "marked": "^0.3.6",
     "matchdep": "^1.0.1",
     "mz": "^2.6.0",
     "node-notifier": "^5.1.2",
     "postcss-image-inliner": "^1.0.6",
-    "postcss-import": "^9.1.0",
-    "postcss-url": "^5.1.2",
+    "postcss-import": "^10.0.0",
+    "postcss-url": "^6.1.0",
     "prismjs": "^1.6.0",
-    "react-docgen": "^2.14.0",
+    "react-docgen": "^2.15.0",
     "recast": "^0.12.3",
     "run-sequence": "^1.2.2",
     "stylelint": "^7.10.1",
-    "stylelint-order": "^0.4.3",
+    "stylelint-order": "^0.4.4",
     "stylelint-scss": "^1.4.4",
     "through2": "^2.0.3",
     "tota11y": "^0.1.6",
     "vinyl-source-stream": "^1.1.0",
-    "webpack": "^2.4.1",
-    "webpack-dev-middleware": "^1.10.1",
+    "webpack": "^2.5.1",
+    "webpack-dev-middleware": "^1.10.2",
     "webpack-hot-middleware": "^2.18.0",
-    "yargs": "^7.1.0",
+    "yargs": "^8.0.1",
     "yernapkg": "^0.5.1",
     "yo": "^1.8.5"
   },
   "optionalDependencies": {
-    "nodegit": "^0.18.0"
+    "nodegit": "^0.18.3"
   },
   "engines": {
-    "node": ">=4.0.0"
+    "node": ">=4.5.0"
   },
   "jest": {
     "testPathIgnorePatterns": [