Coder Social home page Coder Social logo

pattern-library's Introduction

pattern-library

  • Current stable version: 2 (release-2 tag / linkable url)
  • Current development version: 3 (master branch / linkable url)

The pattern library serves as the base CSS and organizing styles for codeforamerica.org. The pattern library is also a living style guide that explains how to use our CSS to build websites.

Who's working on it

Background

Code for America's communications and tech teams worked with Brighton web design firm Clearleft and Colorado branding firm Dojo4 to create a new visual design and front-end for the Code for America website. This pattern library is used as the base for the following:

Read more about pattern libraries here:

How to use it to build websites

  1. Read the docs. Complete documentation of the pattern library with copy-and-pastable code snippets is available at http://style.codeforamerica.org.
  2. Pick your version. The current stable version is 2. The current development version is 3.
  3. Add links to your document head. For example, like this:
<head>
  ...
  <link rel="stylesheet" href="//style.codeforamerica.org/2/style/css/main.css">
  <link rel="stylesheet" href="//style.codeforamerica.org/2/style/css/layout.css" media="all and (min-width: 40em)">
  <link href="//style.codeforamerica.org/2/style/css/prism.css" rel="stylesheet" />
  ...
</head>

Note that you should include your chosen version number (i.e. /2/) in the url path.

Versioning

Note: we are still updating our versioning process. Your feedback is welcome in the issues.

Releases are currently seperated between major (full number releases, i.e. 0, 1, 2) and minor (dot releases, i.e. 2.1). Minor changes are essentially bug fixes and are intended to be fully backwards compatible. Minor changes don't trigger a new URL to a new stylesheet (i.e. release 2.1 is still available from http://style.codeforamerica.org/2/style/css/). If you link directly to our stylesheets, you will automatically get minor releases.

Major releases will attempt to preserve backwards compatability, but may introduce some quirks or require markup changes after upgrade. Please watch the repo to get updates on when major releases are available. The current stable major release is 2. The current development major release is 3.

How to deploy it

Coming soon.

Contributing

We welcome bugs, questions and suggestions in the form of issues, or features and code fixes in the form of a pull request.

Submitting a Pull Request

  1. Fork the project.
  2. Create a topic branch (name it something verb-y, like fix-layout-padding).
  3. Make your changes, and commit with descriptive commit messages.
  4. Push your changes.
  5. Submit a pull request.

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a screenshot and any additioanl details that can help us debug, such as your operating system and browser version.

License

Copyright (c) 2009-2015 Code for America. See the LICENSE for details.

pattern-library's People

Contributors

aaronpava avatar adactio avatar jrubenoff avatar maban avatar mick avatar migurski avatar ondrae avatar phae avatar tmaybe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

pattern-library's Issues

A mechanism for alerting style users of version bumps

This issue in the CFA repo should now be against this repo, so I'm moving it over.

@daguar: "@phae asked me to add this. I encountered breakage recently (I had used pre-version URL implementation), so it would be good to have some system to track and alert users."

@migurski: "Thanks guys. There are three pegged versions of the style guide (0, 1, 2). They differ in small ways mostly connected to fonts. I’ll add information about this to the front page."

@migurski: "Moving forward, it's going to be mostly-correct to peg to a version for anything that's not the website, and to use root for the website."

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.