Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 2.57 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 love all friendly contributions.

We want to ensure a welcoming environment for all of our projects. Our staff follow 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.

Coding Standards

Extending the U.S. Web Design System

Since the Login.gov Design System is based upon the U.S. Web Design System (USWDS), the code should reflect this:

  • Where possible, use the available Sass theme variables to customize the appearance of components. These are configured under src/scss/uswds-theme. We only include the customized variables, to improve visibility of where differences are expected. Refer to the USWDS theme variables source for the full set of configuration values.
  • To limit side-effects and to clarify where styles are extended, customized USWDS styles should follow as close to the file location and CSS selector as possible. For example, if USWDS defines a selector .usa-overlay in src/stylesheets/components/_header.scss which defines a style background that we want to override, the style should be located at an identically-named selector in src/scss/components/_header.scss in this project.
  • Prefer color and size tokens when possible. Never use hard-coded hex colors. Instead, use the color SCSS function with a color token as its argument.

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.