Skip to content

Commit

Permalink
Merge pull request #230 from primer/mono
Browse files Browse the repository at this point in the history
Primer monorepo
  • Loading branch information
broccolini authored Jun 23, 2017
2 parents 20a480b + a95e2c2 commit fd90b09
Show file tree
Hide file tree
Showing 313 changed files with 13,555 additions and 36 deletions.
79 changes: 79 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
## Contributing

[fork]: https://github.com/github/primer/fork
[pr]: https://github.com/github/primer/compare
[style]: http://primercss.io/guidelines/

Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Before you do, would you mind reading [this license agreement](CLA.md)? If you open a PR, we'll assume you agree to it. If you have any hesitation or disagreement, please do open a PR still, but note your concerns as well.

## Using the issue tracker

The issue tracker is the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests) and [submitting pull requests](#pull-requests), but please respect the following restrictions:

* Please **do not** use the issue tracker for personal support requests.
* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.
* Please **do not** open issues or pull requests regarding the code in [`Normalize`](https://github.com/necolas/normalize.css) (open them in their respective repositories).

## Bug reports

A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

Guidelines for bug reports:

0. **Validate and lint your code** — [validate your HTML](http://html5.validator.nu) to ensure your problem isn't caused by a simple error in your own code.

1. **Use the GitHub issue search** — check if the issue has already been reported.

2. **Check if the issue has been fixed** — try to reproduce it using the latest `master` or development branch in the repository.

3. **Isolate the problem** — ideally create a [reduced test case](http://css-tricks.com/6263-reduced-test-cases/) and a live example.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs.

Example:

> Short and descriptive example bug report title
>
> A summary of the issue and the browser/OS environment in which it occurs. If
> suitable, include the steps required to reproduce the bug.
>
> 1. This is the first step
> 2. This is the second step
> 3. Further steps, etc.
>
> `<url>` - a link to the reduced test case
>
> Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).
## Feature requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

## Pull requests

Good pull requests—patches, improvements, new features—are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Adhering to the following process is the best way to get your work included in the project:

1. Fork and clone the repository
2. Configure and install the dependencies: `bower install`
3. Create a new branch: `git checkout -b my-branch-name`
4. Make your change, add tests, and make sure the tests still pass
5. Push to your fork and [submit a pull request][pr]
6. Pat your self on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

- Follow the [style guide][style].
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).

## Resources

- [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
- [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
- [GitHub Help](https://help.github.com)
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.DS_Store
.sass-cache
node_modules
*.log
build
_site
docs
29 changes: 29 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,32 @@
language: node_js
node_js:
- '7'
env:
- TEST_DIR=packages/primer-css
- TEST_DIR=packages/primer-core
- TEST_DIR=packages/primer-product
- TEST_DIR=packages/primer-marketing
- TEST_DIR=packages/primer-alerts
- TEST_DIR=packages/primer-base
- TEST_DIR=packages/primer-blankslate
- TEST_DIR=packages/primer-box
- TEST_DIR=packages/primer-breadcrumb
- TEST_DIR=packages/primer-buttons
- TEST_DIR=packages/primer-cards
- TEST_DIR=packages/primer-forms
- TEST_DIR=packages/primer-labels
- TEST_DIR=packages/primer-layout
- TEST_DIR=packages/primer-markdown
- TEST_DIR=packages/primer-marketing
- TEST_DIR=packages/primer-marketing-type
- TEST_DIR=packages/primer-marketing-utilities
- TEST_DIR=packages/primer-navigation
- TEST_DIR=packages/primer-page-headers
- TEST_DIR=packages/primer-page-sections
- TEST_DIR=packages/primer-support
- TEST_DIR=packages/primer-table-object
- TEST_DIR=packages/primer-tables
- TEST_DIR=packages/primer-tooltips
- TEST_DIR=packages/primer-truncate
- TEST_DIR=packages/primer-utilities
script: cd $TEST_DIR && npm install && npm test
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# Primer CSS

[![NPM version](http://img.shields.io/npm/v/primer-css.svg)](https://www.npmjs.org/package/primer-css)
[![npm version](http://img.shields.io/npm/v/primer-css.svg)](https://www.npmjs.org/package/primer-css)
[![Build Status](https://travis-ci.org/primer/primer-css.svg?branch=master)](https://travis-ci.org/primer/primer-css)

> Primer is the CSS toolkit that powers GitHub's front-end design. It's purposefully limited to common components to provide our developers with the most flexibility, and to keep GitHub uniquely *GitHubby*. It's built with SCSS and available via NPM, so it's easy to include all or part of it within your own project.
Primer is the CSS framework that powers GitHub's front-end design. Primer CSS includes 23 packages that are grouped into 3 core meta-packages for easy install. Each package and meta-package is independently versioned and distributed via npm, so it's easy to include all or part of Primer within your own project.

This repository is a compilation of [several CSS modules](https://github.com/primer).
## Packages

The Primer CSS repo is managed as a monorepo that is composed of many npm packages.

### Core Packages

| Package | Version |
|---|---|
| **[primer-css](/packages/primer-css)** <br />Includes all 23 packages | [![npm](http://img.shields.io/npm/v/primer-css.svg)](https://www.npmjs.com/package/primer-css) |
| [primer-core](/packages/primer-core) | [![npm](http://img.shields.io/npm/v/primer-core.svg)](https://www.npmjs.com/package/primer-core) |
| [primer-product](/packages/primer-product) | [![npm](http://img.shields.io/npm/v/primer-product.svg)](https://www.npmjs.com/package/primer-product) |
| [primer-marketing](/packages/primer-marketing) | [![npm](http://img.shields.io/npm/v/primer-marketing.svg)](https://www.npmjs.com/package/primer-marketing) |

## Install

Expand All @@ -27,7 +38,7 @@ You can also import specific portions of the module by importing those partials

## Build

For a compiled **css** version of this module, a npm script is included that will output a css version to `build/build.css` The built css file is also included in the npm package.
For a compiled **CSS** version of this module, a npm script is included that will output a CSS version to `build/build.css` The built CSS file is also included in the npm package.

```
$ npm run build
Expand Down
7 changes: 7 additions & 0 deletions lerna.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"lerna": "2.0.0-rc.2",
"packages": [
"packages/*"
],
"version": "independent"
}
38 changes: 6 additions & 32 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,37 +1,11 @@
{
"version": "6.0.0",
"name": "primer-css",
"description": "Primer is the CSS toolkit that powers GitHub's front-end design. It's purposefully limited to common components to provide our developers with the most flexibility, and to keep GitHub uniquely *GitHubby*. It's built with SCSS, so it's easy to include all or part of it within your own project.",
"homepage": "http://primercss.io/",
"author": "GitHub, Inc.",
"license": "MIT",
"style": "build/build.css",
"files": [
"index.scss",
"lib",
"build"
],
"repository": "https://github.com/primer/primer.git",
"bugs": {
"url": "https://github.com/primer/primer/issues"
},
"private": true,
"scripts": {
"build": "primer-module-build index.scss",
"prepublish": "npm run build",
"test": "npm run build"
"bootstrap": "lerna bootstrap",
"publish": "lerna publish",
"updated": "lerna updated"
},
"dependencies": {
"primer-core": "^3.0.0",
"primer-marketing": "^3.0.0",
"primer-product": "^3.0.0"
},
"devDependencies": {
"primer-module-build": "*"
},
"keywords": [
"primer",
"css",
"github",
"primercss"
]
"lerna": "^2.0.0-rc.2"
}
}
3 changes: 3 additions & 0 deletions packages/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Primer modules

Primer CSS is monorepo composed of 23 packages which can be installed altogether or individually via npm. We group our packages into 3 meta-packages which you can install individually: [primer-core](primer-core), [primer-product](primer-product), and [primer-marketing](primer-marketing). Install [primer-css](primer-css) if you want to install all 23 packages.
3 changes: 3 additions & 0 deletions packages/primer-alerts/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
build
*.log
2 changes: 2 additions & 0 deletions packages/primer-alerts/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.yml
.github
6 changes: 6 additions & 0 deletions packages/primer-alerts/.postcss.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"use": ["autoprefixer"],
"autoprefixer": {
"browsers": "> 5%, last 2 firefox versions, last 2 chrome versions, last 2 safari versions, last 2 edge versions, ie 11"
}
}
5 changes: 5 additions & 0 deletions packages/primer-alerts/.stylelintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": [
"stylelint-config-primer"
]
}
95 changes: 95 additions & 0 deletions packages/primer-alerts/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# v1.1.2

* patch bump - broccolini [github/github@3c26562](https://github.com/github/github/commit/3c26562)

# v1.1.1

* Bump all the version numbers for readme - Mu-An Chiou [github/github@a9d152f](https://github.com/github/github/commit/a9d152f)

# v1.1.0

* update version numbers in primer-product - broccolini [github/github@5301936](https://github.com/github/github/commit/5301936)
* missed a yellow in flash alerts: - broccolini [github/github@8725991](https://github.com/github/github/commit/8725991)
* update flash red variables - broccolini [github/github@2945319](https://github.com/github/github/commit/2945319)
* yellow flash warn variables - broccolini [github/github@5b64376](https://github.com/github/github/commit/5b64376)
* new flash green variables - broccolini [github/github@80401a0](https://github.com/github/github/commit/80401a0)
* update blues: - broccolini [github/github@9b191b6](https://github.com/github/github/commit/9b191b6)

# v1.0.2

* update version numbers for primer package with bold update - broccolini [github/github@5d3e089](https://github.com/github/github/commit/5d3e089)

# v1.0.1

* More versions - Jon Rohan [github/github@e12ba2e](https://github.com/github/github/commit/e12ba2e)
* Pointing main js file to build - Jon Rohan [github/github@3575651](https://github.com/github/github/commit/3575651)

# v1.0.0

* updating versions after running version script - broccolini [github/github@61b8c6f](https://github.com/github/github/commit/61b8c6f)
* Some updates based on feedback - Jon Rohan [github/github@8a4919d](https://github.com/github/github/commit/8a4919d)

# v0.4.0

* Cutting new versions of primer modules - Jon Rohan [github/github@157f5ab](https://github.com/github/github/commit/157f5ab)
* Rename repository with prefix primer- - Jon Rohan [github/github@ec8774a](https://github.com/github/github/commit/ec8774a)
* Separating out modules into primer-core and primer-product - Jon Rohan [github/github@ddf698c](https://github.com/github/github/commit/ddf698c)

# v0.3.1

* Updating version - Jon Rohan [github/github@6bf5fe5](https://github.com/github/github/commit/6bf5fe5)
* Updating link to real primer-css repository - Jon Rohan [github/github@bbaedda](https://github.com/github/github/commit/bbaedda)
* Updating the modules stylelint - Jon Rohan [github/github@389609f](https://github.com/github/github/commit/389609f)
* Make sure the modules build without error before publishing - Jon Rohan [github/github@57ac5e6](https://github.com/github/github/commit/57ac5e6)
* Adding documentation status to most of the modules - Jon Rohan [github/github@b97695c](https://github.com/github/github/commit/b97695c)

# v0.3.0

* Publishing a new version - Jon Rohan [github/github@eed0e96](https://github.com/github/github/commit/eed0e96)
* Updating octicons to deprecate the use of :symbol - Jon Rohan [github/github@9eb0c63](https://github.com/github/github/commit/9eb0c63)
* Lots of refactoring and tests written - Jon Rohan [github/github@6e3ac10](https://github.com/github/github/commit/6e3ac10)
* Removing some unnecessary lint plugins and using native - Jon Rohan [github/github@2ae0070](https://github.com/github/github/commit/2ae0070)
* including no-utility lint plugin - Jon Rohan [github/github@5cb86ed](https://github.com/github/github/commit/5cb86ed)
* Adding lint plugins for new config - Jon Rohan [github/github@7fb9613](https://github.com/github/github/commit/7fb9613)
* Mentioning the build file - Jon Rohan [github/github@64ca4a7](https://github.com/github/github/commit/64ca4a7)

# v0.2.6

* Including build in files - Jon Rohan [github/github@817ee23](https://github.com/github/github/commit/817ee23)

# v0.2.5

* skipping cleanup - Jon Rohan [github/github@d6b3678](https://github.com/github/github/commit/d6b3678)

# v0.2.4

* Bump version, and including build/build.css in npm package - Jon Rohan [github/github@09cb3a3](https://github.com/github/github/commit/09cb3a3)
* setup unless installed - Jon Rohan [github/github@a798fb0](https://github.com/github/github/commit/a798fb0)
* Using a simplier script setup - Jon Rohan [github/github@be103f4](https://github.com/github/github/commit/be103f4)
* Renaming to compile - Jon Rohan [github/github@196d7ef](https://github.com/github/github/commit/196d7ef)
* Updating modules to run on prepublish to include build.css in distribution - Jon Rohan [github/github@5b573a0](https://github.com/github/github/commit/5b573a0)
* Re-ordering the docs to the bottom of the readme - Jon Rohan [github/github@9c1f291](https://github.com/github/github/commit/9c1f291)
* Updating the link - Jon Rohan [github/github@f67684b](https://github.com/github/github/commit/f67684b)

# v0.2.1

* Bumping version to include postcss.json in npm - Jon Rohan [github/github@9e560ba](https://github.com/github/github/commit/9e560ba)
* Using stylelint to lint the modules instead of scss_lint - Jon Rohan [github/github@cb0b8fd](https://github.com/github/github/commit/cb0b8fd)
* Updating for stylelint instead of scss_lint - Jon Rohan [github/github@87a2c68](https://github.com/github/github/commit/87a2c68)

# v0.2.0

* Cutting new version 0.2.0 - Jon Rohan [github/github@a6f6586](https://github.com/github/github/commit/a6f6586)
* Don't link requirements - Jon Rohan [github/github@7740e81](https://github.com/github/github/commit/7740e81)
* Updating the README with more detailed instructions - Jon Rohan [github/github@5dd7c34](https://github.com/github/github/commit/5dd7c34)
* Reorganize the module folders into a more flexible organization - Jon Rohan [github/github@5a07101](https://github.com/github/github/commit/5a07101)
* Remove partial underscore from name - Jon Rohan [github/github@e463779](https://github.com/github/github/commit/e463779)
* Some cleanup on the readme - Jon Rohan [github/github@74850d5](https://github.com/github/github/commit/74850d5)
* cleaning up the package.json files - Jon Rohan [github/github@77763a1](https://github.com/github/github/commit/77763a1)
* Adding npm version badges to readme - Jon Rohan [github/github@90b1871](https://github.com/github/github/commit/90b1871)
* Adding tavisci build badges to the readmes - Jon Rohan [github/github@1a6126f](https://github.com/github/github/commit/1a6126f)

# v0.1.0

* Updating support dependency versions - Jon Rohan [github/github@76d97ec](https://github.com/github/github/commit/76d97ec)
* Moving primer/primer alerts to a module - Jon Rohan [github/github@1f434c1](https://github.com/github/github/commit/1f434c1)
21 changes: 21 additions & 0 deletions packages/primer-alerts/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 GitHub Inc.

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.
Loading

0 comments on commit fd90b09

Please sign in to comment.