Skip to content

Commit

Permalink
Various updates for beta.8
Browse files Browse the repository at this point in the history
  • Loading branch information
mirisuzanne committed Nov 29, 2019
1 parent 76065e7 commit f5f4c73
Show file tree
Hide file tree
Showing 21 changed files with 548 additions and 327 deletions.
4 changes: 2 additions & 2 deletions .sassdocrc
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ herman:
path: CHANGELOG.md
- name: 'Contributing'
path: CONTRIBUTING.md
- name: 'License'
path: LICENSE
- name: 'Hipocratic MIT License'
path: LICENSE.md
extraLinks:
- name: 'Demo'
url: 'https://cascading-colors.netlify.com/'
Expand Down
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# Changelog

## 0.1.0-beta.8 - 2019/11/29

- BREAKING: Set defaults on `background-color`
rather than `background` shorthand
- BREAKING: `--ccs-custom-display` and `--ccs-field-display` variables
for more customized control of CCS menu field display
- BREAKING: Set `background-color` and `color` on all `[data-ccs-colors]`,
with both fallback values and variables defaulting to
`--ccs-neutral--(fg/bg)-full`
- BREAKING: Re-order the output from general to specific
- NEW: `--ccs-background` and `--ccs-color` override the default
`[data-ccs-colors]` background and text
- NEW: `$neutral-hue` and `--ccs-neutral--config` for setting neutral hues
- NEW: `$neutral-saturation` and `--ccs-s-neutral--config`
override contrast-based saturation on neutral palette
- MOVE: `LICENSE` => `LICENSE.md` (and fix in `package.json`)

## 0.1.0-beta.7 - 2019/10/9

- BREAKING: rename `[data-ccs="*-select"]` attributes
Expand Down
43 changes: 42 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,44 @@
# Contributing

...
Run `yarn` to install dependencies…

## Organization

- `css/`: GENERATED CSS for use without a build step
- `docs/`: GENERATED SassDoc/Herman documentation
- `sass/`: the tool itself
- `config/`: all the use-defined variables
- `partials/`: all the logic and output
- `_ccs.scss`: forwards the combined Sass module
- `_output.scss`: generates the default CSS output
- `site/`: Styles for the demo site (also used for testing)
- `_index.scss`: Root-level index file for importing the module

## Development

The following scripts can help you work:

- `yarn build-sass`: compiles the `output` file to `css/ccs.css`
- `yarn build-docs`: compiles SassDoc/Herman documentation
- `yarn build-js`: compiles `dist.js` for packaging
- `yarn build-site`: compiles the demo site styles
- `yarn build` or `yarn commit`: all the build steps at once
- `yarn watch`: a watcher for the site styles

## Process

1. Create a new branch for each feature/bug being addressed
2. Make any changes required
3. Update inline documentation as you go
4. Document changes in [CHANGELOG.md](./CHANGELOG.md)
5. Run `yarn commit`
6. Commit your changes
7. Create a Pull Request on GitHub

## Release

1. Update `package.json`
2. Run `yarn commit` to update generated docs
3. Commit and push changes
4. Create release through GitHub UI
5. Pull changes, and `npm publish`
33 changes: 0 additions & 33 deletions LICENSE

This file was deleted.

45 changes: 45 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
Copyright 2019 OddBird

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.

* No Harm: The software may not be used by anyone for systems or activities
that actively and knowingly endanger, harm, or otherwise threaten
the physical, mental, economic, or general well-being
of other individuals or groups,
in violation of the United Nations Universal Declaration of Human Rights
(https://www.un.org/en/universal-declaration-human-rights/).

* Services: If the Software is used to provide a service to others,
the licensee shall, as a condition of use, require those others
not to use the service in any way that violates the No Harm clause above.

* Enforceability: If any portion or provision of this License shall
to any extent be declared illegal or unenforceable
by a court of competent jurisdiction, then the remainder of this License,
or the application of such portion or provision
in circumstances other than those as to which
it is so declared illegal or unenforceable, shall not be affected thereby,
and each portion and provision of this Agreement
shall be valid and enforceable to the fullest extent permitted by law.

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.

This Hippocratic License is an Ethical Source license
(https://ethicalsource.dev) derived from the MIT License,
amended to limit the impact of the unethical use of open source software.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,11 @@ and fallback values for both modes:
```scss
// fallback values, in case variables are not supported
[data-ccs='root'] {
background: $fallback-light;
background-color: $fallback-light;
color: $fallback-dark;

@media (prefers-color-scheme: dark) {
background: $fallback-dark;
background-color: $fallback-dark;
color: $fallback-light;
}
}
Expand Down Expand Up @@ -197,9 +197,6 @@ using the `[data-ccs-theme]` attribute:
[data-ccs-theme='triad'] {
/* triad logic */
}
[data-ccs-theme='adjacent'] {
/* adjacent logic */
}
```

### Sass Configuration
Expand Down
Loading

0 comments on commit f5f4c73

Please sign in to comment.