Skip to content

Commit

Permalink
Merge pull request #281 from IBM-Watson/develop
Browse files Browse the repository at this point in the history
Release rc.1
  • Loading branch information
Snugug committed May 12, 2015
2 parents 2a4f3e4 + bb23c71 commit d949129
Show file tree
Hide file tree
Showing 214 changed files with 3,261 additions and 1,451 deletions.
3 changes: 0 additions & 3 deletions .deploy.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ set -e # exit with nonzero exit code if anything fails

if [ "$TRAVIS_BRANCH" = "master" ]
then
# Copy CNAME from .www to www (build folder)
mv .www/CNAME www/CNAME

# Move to build folder and init it
cd www
git init
Expand Down
2 changes: 1 addition & 1 deletion .stackup.sh
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
#! /bin/zsh -i
npm install -g generator-watson
npm install && bundle install
npm install
1 change: 0 additions & 1 deletion .www/CNAME

This file was deleted.

43 changes: 43 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,48 @@
# Watson Design Library Changelog

## v1.0.0-rc.1
*May 7, 2015*

**New**

* Add JavaScript config for rendering the site's JavaScript
* Add Apache 2.0 and CC-BY licenses! All source code is licensed under the Apache 2.0 license, documentation and assets under the CC-BY license
* Add Bottom (previous/next) Nav
* Add Resource panel to Layout template
* Add Styling for header, sidebar, footer, bottom nav, and basic layout
* Add Performance guidelines
* Add Base and Components section, with pattern links
* Add icon font
* Add resource panel

**Changes**

* Move `_base.scss`, `_components.scss`, `_layouts.scss`, and `_core.scss` to `_index.scss` to better align with Node importing
* Rename `crick.scss` to `_watson-patterns.scss` to distribute as a partial and align name
* Add `library` Sass file and folder
* Update colors to current standards
* Add sub-content templates to Offer Control
* Fix a typo on Offer Control
* Remove resources template from Accessibility
* Add subcontent templates to typography guidelines
* Change detail to large example
* Update subcontent templates
* Fix bugs in Subcontent Template ([#255](https://github.com/IBM-Watson/design-library/issues/255))
* Change some details to examples in grids guidelines
* Add sub-content templates to grids guidelines
* Change detail to example
* Update subcontent templates
* Update front matter for responsiveGridVideo
* Add sub-content templates to color guidelines
* Update variables in sub-content templates
* Remove resources template and update front matter
* Add sub-content templates to Introduce Cognitive
* Add sub-content templates to Inform Interactions
* Clean lots of small details
* Update base styling
* Order sections correctly
* Update Accessibility visual example

## v1.0.0-beta.3
*April 28, 2015*

Expand Down
26 changes: 15 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to the IBM Watson Design Library

The Watson Design Library contains the design and development guidelines and resources for creating cognitive experiences. It's built using Sass and available via Bower, so it's easy to include all or part of it within your own project.
The Watson Design Library contains the design and development guidelines and resources for creating cognitive experiences. It's built using Sass and available via Bower, so it's easy to include all or part of it within a project.

_**Heads Up!** We love open source, but the Watson Design Library is unlikely to add new guidelines or features that are not in-line with the work we're doing or won't be used at IBM Watson. Inclusion is at the discretion of the Watson Design team. We really love to share, though, so hopefully that means we're still friends :blue_heart:_

Expand All @@ -22,12 +22,16 @@ The `patterns` folder contains all of the UI patterns and their documentation. D

No patterns rely upon JavaScript frameworks (jQuery, Dojo, Angular, etc…). Any pattern submissions that do will be asked to be rewritten without said dependencies. Acceptable JavaScript dependencies include core JavaScript that we provide and any current dependencies already included in the project. Any additional external dependencies will need to be approved before they can be used. Styling should be written without vendor prefixes. Only web standard features that have [moved beyond](http://en.wikipedia.org/wiki/World_Wide_Web_Consortium#Specification_Maturation) the Candidate Recommendation stage (or equivalent for the relevant standards body) will be considered for inclusion.

## Developing for the Watson Design Library

Whether working on language, library, or patterns, there are a specific set of steps that should be followed in order contribute in a standard and consistent manner. Our wiki contains the full instructions for [setting up and working with the Watson Design Library](https://github.com/IBM-Watson/design-library/wiki/Developing-for-the-Design-Library).

## Submitting Issues

* Before creating a new issue, perform a [cursory search](https://github.com/issues?utf8=%E2%9C%93&q=is%3Aissue+user%3Aibm-watson+) to see if a similar issue has already been submitted.
* You can create an issue [here](https://github.com/IBM-Watson/design-library/issues). Please include as many details as possible in your report.
* Can create an issue [here](https://github.com/IBM-Watson/design-library/issues). Please include as many details as possible when filing an issue.
* Issue titles should be descriptive, explaining at the high level what it is about, and should be written in the same style as [Git commit messages](#git-commit-messages).
* Please include the version of the Design Library you are using/viewing
* Please include the version of the Design Library being used or viewed
* Do not open a [pull request](#pull-requests) to resolve an issue without first receiving feedback from a `collaborator` or `owner` and having them agree on a solution forward.
* Include screenshots and animated GIFs whenever possible; they are immensely helpful.
* When submitting a browser bug, please include the browser, version, operating system, and operating system version.
Expand All @@ -38,15 +42,14 @@ No patterns rely upon JavaScript frameworks (jQuery, Dojo, Angular, etc…). Any
## Pull Requests

* **DO NOT ISSUE A PULL REQUEST WITHOUT FIRST [SUBMITTING AN ISSUE](#submitting-issues)**
* Pull requests should reference their related issues. If the pull request closes an issue, [please reference its closing in your commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/). Pull requests not referencing any issues will be closed.
* Pull requests should reference their related issues. If the pull request closes an issue, [please reference its closing from a commit messages](https://help.github.com/articles/closing-issues-via-commit-messages/). Pull requests not referencing any issues will be closed.
* Pull request titles should be descriptive, explaining at the high level what it is doing, and should be written in the same style as [Git commit messages](#git-commit-messages).
* Update the `CHANGELOG` with the changes made by your pull request, making sure to use the proper [Emoji](#emoji-cheatsheet).
* Make sure you have [installed the development environment](https://github.com/IBM-Watson/design-library#installation), [updated your runner to the latest version](https://github.com/IBM-Watson/design-library#updating-the-runner), and have [run the library locally](https://github.com/IBM-Watson/design-library#running-locally) to ensure that your code works properly.
* Update the [CHANGELOG](#maintaining-thechangelog) with the changes made by the pull request, making sure to use the proper [Emoji](#emoji-cheatsheet).
* Make sure that the steps for [Developing for the Watson Design Library](https://github.com/IBM-Watson/design-library/wiki/Developing-for-the-Design-Library) have been followed
* Follow our JavaScript and CSS styleguides. We have linters set up to catch most of it.
* Ensure that you have [EditorConfig](http://editorconfig.org/) installed in your editor of choice and that it is functioning properly.
* Do not squash or rebase your commits when submitting a Pull Request. It makes it much harder to follow your work and make incremental changes.
* Update the [CHANGELOG](#maintaining-thechangelog) with your changes.
* Ensure no Emoji tags are used in the title of your Pull Request
* Ensure that [EditorConfig](http://editorconfig.org/) installed in the editor used to work on the library and that it is functioning properly.
* Do not squash or rebase commits when submitting a Pull Request. It makes it much harder to follow work and make incremental changes.
* Ensure no Emoji tags are used in the title of the Pull Request

### Git Commit Messages

Expand All @@ -58,6 +61,7 @@ No patterns rely upon JavaScript frameworks (jQuery, Dojo, Angular, etc…). Any
### Branching Model

* Branches must be made off of the most current `develop` branch from `[email protected]:IBM-Watson/design-library.git`
* Branch names should be descriptive, describing what is being done in that branch
* Pull requests must be made into our [develop](https://github.com/IBM-Watson/design-library/tree/develop) branch.
* The following branch prefixes should be used when creating a new branch:
* `hotfix/` - bug fixes that got through and need to be squashed
Expand All @@ -71,7 +75,7 @@ No patterns rely upon JavaScript frameworks (jQuery, Dojo, Angular, etc…). Any

Versioning is done through [SEMVER](http://semver.org/). When creating a new version, issue a [pull request](#pull-requests) from `develop` into `master` and create new release branch off of `master` with the version's name, and create a new tag with `v` prefixed with the version's name from that branch.

For instance, if you are creating version `1.1.0`, you would start by merging `develop` into `master`, create a branch `release/1.1.0` from `master`, and create a tag `v1.1.0` from branch `release/1.1.0`.
For instance, when creating version `1.1.0`, start by merging `develop` into `master`, create a branch `release/1.1.0` from `master`, and create a tag `v1.1.0` from branch `release/1.1.0`.

### Maintaining the Changelog

Expand Down
Loading

0 comments on commit d949129

Please sign in to comment.