guides_style_18f 0.4.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e522221bb24ba7e951f447d1dca197206038951
-  data.tar.gz: 6fc69db673871e064bb8ee7c5344da4dd6c014f7
+  metadata.gz: 250cf18c217df1c23746ed023bea3329bcb95e30
+  data.tar.gz: 59cae6c1b16d13183da35c5326d0ad15931b09b2
 SHA512:
-  metadata.gz: 95abe49659bb77122625a5393f49fede8123621f27198ca2c36fb1a4c7625f24a4634c5df51817627a6809bb4961d610440dcc2394e574ffb08bcf14075521f8
-  data.tar.gz: a127678c2626847e7161538a5a06a599a43b7c77473b6220e9371a0a83d565f64ff78d2e256f51b862951eb9d2fad8480e6aaecba79f67541b3e429a1bbc4e42
+  metadata.gz: c3e4bb27a5593111ac013ff8b8a7ece99c6fa6f322b66b645a5751d40d616da51eaafa906a81304b8de38e13f52097e5328c20a97b68a810ed531bb301e93017
+  data.tar.gz: 1ed69343476cbf9ecb75acf7545535c5fa60e27d96cfa9c4c52ff13135411d0a12d1a2c633d67b73b7e3e781f71dc5e405a432a8967a840285965350a4f772cc

data/assets/css/main.css

@@ -0,0 +1,2 @@
+@import 'search.css';
+@import 'page.css';

data/assets/css/page.css

@@ -0,0 +1,36 @@
+/* Addenda to the USWDS styles. */
+
+header,
+aside {
+  margin-bottom: 5rem; /* taken from WDS styleguide layout */
+}
+
+footer {
+  margin-top: 5rem;
+}
+
+.usa-footer-logo {
+  padding-top: 1rem;
+}
+
+.usa-footer-nav {
+  text-align: right;
+  border-right: 1px solid #d6d7d9;
+}
+
+.usa-footer-nav ul {
+  margin-right: 1rem;
+  padding-right: 1rem;
+}
+
+.usa-footer-slim .usa-footer-nav .usa-footer-primary-content {
+  margin-right: 0;
+}
+
+.usa-footer .usa-footer-primary-link {
+  padding: 0;
+}
+
+.usa-footer div:last-child .usa-footer-primary-content {
+  padding: 1rem 0;
+}

data/assets/css/search.css

@@ -0,0 +1,24 @@
+/* Additional CSS needed to properly style the search bar.
+ * This is only necessary because we're using the
+ * jekyll_pages_api_search_interface tag instead of the USWDS markup. */
+
+.usa-search .search-interface .label-text {
+  position: absolute;
+  left: -999em;
+}
+
+.usa-search .search-interface [type=submit] {
+  color: rgba(0,0,0,0);
+}
+
+@media screen and (min-width: 951px) {
+  .usa-nav-secondary .usa-search {
+    margin-top: -3rem;
+  }
+}
+
+@media screen and (max-width: 950px) {
+  .usa-nav-secondary {
+    margin-top: 6rem;
+  }
+}

data/assets/uswds/CONTRIBUTING.md

@@ -0,0 +1,108 @@
+## 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 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.
+
+One of our goals is to ensure a welcoming environment for all contibutors to our projects. Our staff follows the [18F Code of Conduct](https://github.com/18F/code-of-conduct/blob/master/code-of-conduct.md), and all contributors should do the same.
+
+We encourage you to read this project’s CONTRIBUTING policy (you are here), its [LICENSE](https://github.com/18F/web-design-standards/blob/staging/LICENSE.md), [README](https://github.com/18F/web-design-standards/blob/staging/README.md) and its [Workflow](https://github.com/18F/web-design-standards/wiki/Workflow) process.
+
+If you have any questions or want to read more, check out the [18F Open Source Policy GitHub repository]( https://github.com/18f/open-source-policy), or just [shoot us an email](mailto:18f@gsa.gov).
+
+## Guidelines
+
+### Contributor Guidelines for Design
+We have provided some guidelines for folks that would like to submit new components to the U.S. Web Design Standards and the lifecycle those new components will go through. For more detail, please visit the [guidelines on our wiki](https://github.com/18F/web-design-standards/wiki/Contribution-Guidelines:-Design).
+
+### 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.
+1. 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/](https://help.github.com/articles/fork-a-repo/)
+1. Create a branch from `staging` that lightly defines what you’re working on (for example, add-styles).
+1. Ensure that your contribution works via `npm`, if applicable. See below under
+   _Install the package locally via `npm-link`_.
+1. Once you’re ready to submit a pull request, fill out the PULL REQUEST template provided.
+1. Submit your pull request against the `staging` branch.
+
+Have questions or need help with setup? Open an issue here [https://github.com/18F/web-design-standards/issues](https://github.com/18F/web-design-standards/issues).
+
+### Running locally
+
+The U.S. Web Design Standards `uswds` package (the ZIP download and the files needed to use the Standards on your project) is built using gulp automation. To use gulp, first make sure you've installed it on your machine globally.
+
+```sh
+npm install --global gulp-cli
+```
+
+Then, to start, run the following command to install any new dependencies:
+
+```sh
+npm install
+```
+
+The following examples detail a few `npm` commands that alias our gulp tasks and that are useful throughout local development:
+
+```sh
+npm test
+```
+
+This command runs the gulp task for `eslint` and our test suite for the `uswds` package. It is an alias for `gulp eslint test`.
+
+```sh
+npm run build
+```
+
+This command builds the `uswds` package. It is an alias for `gulp build`.
+
+```sh
+npm run build:package
+```
+
+This command builds the `uswds` package, which includes the zip files generated for release purposes. It is an alias for `gulp copy-vendor-sass && gulp release`.
+
+
+```sh
+npm run watch
+```
+
+This command watches for any changes that happen in the `src` directory and rebuilds the package if any changes are made.
+
+## Coding guidelines
+
+The purpose of our coding styleguides are to create consistent coding practices across 18F. The styleguide should be treated as a guide — rules can be modified according to project needs.
+
+This project follows the 18F Front End Guide [CSS](https://pages.18f.gov/frontend/#css) and [JavaScript](https://pages.18f.gov/frontend/#javascript). Please use this guide for your reference.
+
+## Our use of branches
+
+The `staging` branch is the bleeding edge of development. When cutting a new [release](https://github.com/18F/web-design-standards/releases), we update the versioning on our files by branching off of the `staging` branch and submitting a pull request into our `release` branch. This helps to make `staging` a place that can always receive contributions, no matter where we are in the release process. New commits to `staging` are automatically deployed to [our staging site](https://standards-staging.usa.gov/).
+
+The `master` branch always holds the latest production-ready release. When cutting a [release](https://github.com/18F/web-design-standards/releases), we create a release branch from `staging` named for the new version: for example, `v0.9.x`. Once we’ve completed QA on that branch, we tag the release and merge it into the `master` branch.
+
+The branches `18f-pages` and `18f-pages-staging` _used_ to be the primary release and development branches, back when the site was hosted on `pages.18f.gov`. Those branches still auto deploy to 18F Pages, but will now only contain minimal redirects to the new site.
+
+## Licenses and attribution
+
+### A few parts of this project are not in the public domain
+
+For complete attribution and licensing information for parts of the project that are not in the public domain, see [LICENSE.md](https://github.com/18F/web-design-standards/blob/staging/LICENSE.md).
+
+### The rest of this project is in the public domain
+
+The rest of this project is in the worldwide [public domain](https://github.com/18F/web-design-standards/blob/staging/LICENSE.md).
+
+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.

data/assets/uswds/LICENSE.md

@@ -0,0 +1,63 @@
+## A few parts of this project are not in the public domain
+
+### Files licensed under the SIL Open Font License
+
+The Source Sans Pro font files in `src/fonts` are a customized subset of [Source Sans Pro](https://github.com/adobe-fonts/source-sans-pro), licensed under the [SIL Open Font License](http://scripts.sil.org/cms/scripts/page.php?item_id=OFL), and copyright [Adobe Systems Incorporated](http://www.adobe.com/), 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 `src/fonts` are from [Google Web Fonts](https://www.google.com/fonts#UsePlace:use/Collection:Merriweather:400,300,400italic,700,700italic), licensed under the [SIL Open Font License](http://scripts.sil.org/cms/scripts/page.php?item_id=OFL), and copyright [Sorkin Type Co](www.sorkintype.com) with Reserved Font Name 'Merriweather'.
+
+The files in `src/img` 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
+
+The files in `src/stylesheets/lib` are from:
+
+* [Bourbon](http://bourbon.io/), copyright [thoughtbot](https://thoughtbot.com/), inc., under the [MIT license](https://github.com/thoughtbot/neat/blob/master/LICENSE.md).
+* [Neat](http://neat.bourbon.io/), copyright [thoughtbot](https://thoughtbot.com/), inc., also under the [MIT license](https://github.com/thoughtbot/neat/blob/master/LICENSE.md).
+* [Normalize.css](https://github.com/necolas/normalize.css), copyright Nicolas Gallagher and Jonathan Neal, under the [MIT license](https://github.com/necolas/normalize.css/blob/master/LICENSE.md).
+
+The file `src/js/vendor/html5shiv.js` is from [HTML5 Shiv](https://github.com/afarkas/html5shiv), copyright Alexander Farkas (aFarkas), under the [MIT license](https://github.com/aFarkas/html5shiv/blob/master/MIT%20and%20GPL2%20licenses.md).
+
+The file `src/js/vendor/rem.min.js` is from [REM unit polyfill](https://github.com/chuckcarpenter/REM-unit-polyfill), copyright Chuck Carpenter, under the [MIT license](https://github.com/chuckcarpenter/REM-unit-polyfill/blob/master/LICENSE.md).
+
+The file `src/js/vendor/respond.js` is from [Respond.js](https://github.com/scottjehl/Respond), copyright Scott Jehl, under the [MIT license](https://github.com/scottjehl/Respond/blob/master/LICENSE-MIT).
+
+The file `src/js/vendor/selectivizr-min.js` is from [Selectivizr](http://selectivizr.com/), copyright Keith Clark, under the [MIT license](http://opensource.org/licenses/mit-license.php).
+
+#### 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.
+```
+
+## The rest of this project is in the worldwide public domain
+
+As a work of the United States government, 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.

data/assets/uswds/README.md

@@ -0,0 +1,225 @@
+# U.S. Web Design Standards
+
+[![CircleCI Build Status](https://circleci.com/gh/18F/web-design-standards/tree/staging.svg?style=shield)](https://circleci.com/gh/18F/web-design-standards/tree/staging)
+
+The [U.S. Web Design Standards](https://standards.usa.gov) include a library of open source UI components and a visual style guide for U.S. federal government websites.
+
+This repository is for the Standards themselves. 18F maintains [another repository for the documentation and website](https://github.com/18F/web-design-standards-docs). To see the Standards and documentation on the web, visit [https://standards.usa.gov](https://standards.usa.gov).
+
+## Contents
+
+* [Background](#background)
+* [Recent updates](#recent-updates)
+* [Getting started](#getting-started)
+* [Using the Standards](#using-the-standards)
+  * [Download](#download)
+  * [Install using `npm`](#install-using-npm)
+    * [Importing assets](#importing-assets)
+    * [Sass](#sass)
+    * [JavaScript](#javascript)
+  * [Use another framework or package manager](#use-another-framework-or-package-manager)
+* [Need installation help?](#need-installation-help)
+* [Contributing to the code base](#contributing-to-the-codebase)
+* [Reuse of open-source style guides](#reuse-of-open-source-style-guides)
+* [Licenses and attribution](#licenses-and-attribution)
+
+## Background
+
+The components and style guide of the U.S. Web Design Standards follow industry-standard web accessibility guidelines and use the best practices of existing style libraries and modern web design. The [U.S. Digital Service](https://www.whitehouse.gov/digital/united-states-digital-service) and [18F](https://18f.gsa.gov/) created and maintain the U.S. Web Design Standards for designers and developers. They are designed for use by government product teams who want to create beautiful, easy-to-use online experiences for the public. To learn more about the project, check out this [blog post](https://18f.gsa.gov/2015/09/28/web-design-standards/) and to view websites and applications check out our list [here](WHO_IS_USING_USWDS.md).
+
+## Recent updates
+
+Information about the most recent release of the Standards can always be found in the [release history](https://github.com/18F/web-design-standards/releases). We include details about significant updates and any backwards incompatible changes along with a list of all changes.
+
+## Getting started
+
+We’re glad you’d like to use the Standards — here’s how you can get started:
+
+* Designers: [Check out our Getting Started for Designers information](https://standards.usa.gov/getting-started/designers/).
+    * [Design files of all the assets included in the Standards are available for download](https://github.com/18F/web-design-standards-assets/archive/master.zip).
+* Developers: [Follow the instructions in this README to get started.](#using-the-standards)
+    * [CSS, JavaScript, image, and font files of all the assets on this site are available for download](https://github.com/18F/web-design-standards/releases/download/v1.0.0/uswds-1.0.0.zip).
+
+## Using the Standards
+
+There are a few different ways to use the Standards within your project. Which one you choose depends on the needs of your project and how you are most comfortable working. Here are a few notes on what to consider when deciding which installation method to use:
+
+*Download the Standards if:*
+- You are not familiar with `npm` and package management.
+
+*Use the Standards `npm` package if:*
+- You are familiar with using `npm` and package management.
+- You would like to leverage Standards [Sass](#sass) files.
+
+### Download
+
+1. Download the [Standards zip file](https://github.com/18F/web-design-standards/releases/download/v1.0.0/uswds-1.0.0.zip) and open that file.
+
+  After extracting the zip file you should see the following file and folder structure:
+
+  ```
+  uswds-1.0.0/
+  ├── js/
+  │   ├── uswds.min.js.map
+  │   ├── uswds.min.js
+  │   └── uswds.js
+  ├── css/
+  │   ├── uswds.min.css.map
+  │   ├── uswds.min.css
+  │   └── uswds.css
+  ├── img/
+  └── fonts/
+  ```
+
+2. Copy these files and folders into a relevant place in your project's code base. Here is an example structure for how this might look:
+
+  ```
+  example-project/
+  ├── assets/
+  │   ├── uswds-1.0.0/
+  │   ├── stylesheets/
+  │   ├── images/
+  │   └── javascript/
+  └── index.html
+  ```
+
+  You'll notice in our example above that we also outline a `stylesheets`, `images` and `javascript` folder in your `assets` folder. These folders are to help organize any assets that are unique to your project.
+
+3. To use the Standards on your project, you’ll need to reference the [CSS (*C*ascading *S*tyle *S*heets)](https://developer.mozilla.org/en-US/docs/Web/CSS) and JavaScript files in each HTML page or dynamic templates in your project.
+
+  Here is an example of how to reference these assets in your `index.html` file:
+
+  ```html
+  <!DOCTYPE html>
+  <html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <title>My Example Project</title>
+    <link rel="stylesheet" href="assets/uswds-1.0.0/css/uswds.min.css">
+  </head>
+  <body>
+
+    <script src="assets/uswds-1.0.0/js/uswds.min.js"></script>
+  </body>
+  </html>
+  ```
+
+We offer both files, the CSS and the JavaScript, in two versions — a minified version, and an un-minified one. (In the examples above, we are using the minified files.) Use the minified files in a production environment or to reduce the file size of your downloaded assets. And the un-minified files are better if you are in a development environment or would like to debug the CSS or JavaScript assets in the browser.
+
+And that’s it — you should now be able to copy our code samples into our `index.html` and start using the Standards.
+
+### Install using npm
+
+`npm` is a package manager for Node based projects. The U.S. Web Design Standards maintains a [`uswds` package](https://www.npmjs.com/package/uswds) for you to utilize both the pre-compiled and compiled files on your project.
+
+1. Install `Node/npm`. Below is a link to find the install method that coincides with your operating system:
+
+  - Node v4.2.3+, [Installation guides](https://nodejs.org/en/download/)
+
+  **Note for Windows users:** If you are using Windows and are unfamiliar with `Node` or `npm`, we recommend following [Team Treehouse's tutorial](http://blog.teamtreehouse.com/install-node-js-npm-windows) for more information.
+
+2. Make sure you have installed it correctly:
+
+  ```shell
+  npm -v
+  3.10.8 # This line may vary depending on what version of Node you've installed.
+  ```
+
+3. Create a `package.json` file. You can do this manually, but an easier method is to use the `npm init` command. This command will prompt you with a few questions to create your `package.json` file.
+
+4. Add `uswds` to your project’s `package.json`:
+
+  ```shell
+  npm install --save uswds
+  ```
+
+The `uswds` module is now installed as a dependency. You can use the un-compiled files found in the `src/` or the compiled files in the `dist/` directory.
+
+```
+node_modules/uswds/
+├── dist/
+│   ├── css/
+│   ├── fonts/
+│   ├── img/
+│   ├── js/
+└── src/
+    ├── fonts/
+    ├── img/
+    ├── js/
+    └── stylesheets/
+```
+
+#### Importing assets
+
+Since you are already using `npm`, the U.S. Web Design Standards team recommends leveraging the ability to write custom scripts. Here are some links to how we do this with our docs website using `npm` + [`gulp`](http://gulpjs.com/):
+
+[Link to `npm` scripts example in `web-design-standards-docs`](https://github.com/18F/web-design-standards-docs/blob/staging/package.json#L4)
+[Link to gulpfile.js example in `web-design-standards-docs`](https://github.com/18F/web-design-standards-docs/blob/staging/gulpfile.js)
+
+#### Sass
+
+The Standards are easily customizable using the power of [Sass (Syntactically Awesome Style Sheets)](http://sass-lang.com/). The main Sass (SCSS) source file is located here:
+
+```
+node_modules/uswds/src/stylesheets/uswds.scss
+```
+
+Global variables are defined in the `node_modules/uswds/src/stylesheets/core/_variables.scss` file. Custom theming can be done by copying the `_variables.scss` file into your own project’s Sass folder, changing applicable variable values, and importing it before `uswds.scss`.
+
+Below is an example of how you might setup your main Sass file to achieve this:
+
+```
+@import 'variables.scss' # Custom Sass variables file
+@import 'node_modules/uswds/src/stylesheets/uswds.scss';
+
+```
+
+You can now use your copied version of `_variables.scss` to override any styles to create a more custom look and feel to your application.
+
+#### JavaScript
+`require('uswds')` will load all of the U.S. Web Design Standards’ JavaScript onto the page. Add this line to whatever initializer you use to load JavaScript into your application.
+
+
+### Use another framework or package manager
+
+If you’re using another framework or package manager that doesn’t support `npm`, you can find the source files in this repository and use them in your project. Otherwise, we recommend that you follow the [download instructions](#download). Please note that the core team [isn’t responsible for all frameworks’ implementations](https://github.com/18F/web-design-standards/issues/877).
+
+If you’re interested in maintaining a package that helps us distribute the U.S. Web Design Standards, the project’s build system can help you create distribution bundles to use in your project. Please read our [contributing guidelines](CONTRIBUTING.md#building-the-project-locally-with--gulp-) to locally build distributions for your framework or package manager.
+
+## Need installation help?
+
+Do you have questions or need help with setup? Did you run into any weird errors while following these instructions? Feel free to open an issue here:
+
+[https://github.com/18F/web-design-standards/issues](https://github.com/18F/web-design-standards/issues).
+
+You can also email us directly at uswebdesignstandards@gsa.gov.
+
+## Contributing to the code base
+
+For complete instructions on how to contribute code, please read [CONTRIBUTING.md](CONTRIBUTING.md). These instructions also include guidance on how to set up your own copy of the Standards style guide website for development.
+
+If you would like to learn more about our workflow process, check out the [Workflow](https://github.com/18F/web-design-standards/wiki/Workflow) and [Label Glossary](https://github.com/18F/web-design-standards/wiki/Label-glossary) pages on the wiki.
+
+If you have questions or concerns about our contributing workflow, please contact us by [filing a GitHub issue](https://github.com/18F/web-design-standards/issues) or [emailing our team](mailto:uswebdesignstandards@gsa.gov).
+
+## Reuse of open-source style guides
+
+Much of the guidance in the U.S. Web Design Standards leans on open source designs, code, and patterns from other civic and government organizations, including:
+
+* Consumer Financial Protection Bureau’s [Design Manual](https://cfpb.github.io/design-manual/)
+* U.S. Patent and Trademark Office’s [Design Patterns](http://uspto.github.io/designpatterns/)
+* Healthcare.gov [Style Guide](http://styleguide.healthcare.gov/)
+* UK’s Government Digital Service’s [UI Elements](http://govuk-elements.herokuapp.com/)
+* Code for America’s Chime [Styleguide](https://github.com/chimecms/chime-starter)
+* Pivotal Labs [Component Library](http://styleguide.cfapps.io/)
+
+## Licenses and attribution
+
+A few parts of this project are not in the public domain. Attribution and licensing information for those parts are described in detail in [LICENSE.md](LICENSE.md).
+
+The rest of this project is in the worldwide public domain, released under the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
+
+## Contributing
+
+All contributions to this project will be released under the CC0 dedication alongside the public domain portions of this project. For more information, see [CONTRIBUTING.md](CONTRIBUTING.md).