accoutrement-color
Version:
Sass color-palette management and utilities.
245 lines (173 loc) • 7.89 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Contributing | Accoutrement: Color Documentation</title>
<link href="assets/img/favicon.ico" rel="shortcut icon">
<link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:400,600|Source+Sans+Pro:400,400i,700,700i" rel="stylesheet">
<link rel="stylesheet" href="assets/webpack/app_styles.min.css" />
</head>
<body>
<svg xmlns="http://www.w3.org/2000/svg" hidden>
<symbol id="icon-logo" viewBox="0 0 16 16">
<path d="M.2 8L0 7.8v-.2C.8 6.9 1.9 5.9 2.7 5l.4.3c-.5.8-1.1 1.6-1.8 2.3 1 1.2 1 1.3 1.7 2.4l-.4.3c-.4-.4-.5-.6-1-1C1 8.6 1.1 8.7.2 8zM13 10c.6-1.1.7-1.1 1.7-2.4-.6-.6-1.3-1.5-1.7-2.3l.3-.3c.8.8 1.8 1.8 2.7 2.6v.2l-.8.7c-.3.3-1.2 1.1-1.8 1.7L13 10z"/><path d="M2.6 13.1H3c.9 0 1.1-.2 1.1-1.4V4.2c0-1.1-.2-1.4-1.1-1.4h-.4v-.6h4.5v.7h-.3c-.9 0-1.1.2-1.1 1.4v3.2h4.6V4.2c0-1.1-.2-1.4-1.1-1.4h-.3v-.6h4.5v.7H13c-.9 0-1.1.2-1.1 1.4v7.5c0 1.1.2 1.4 1.1 1.4h.4v.7H8.9v-.7h.3c.9 0 1.1-.2 1.1-1.4V8.2H5.7v3.5c0 1.1.2 1.4 1.1 1.4h.3v.7H2.6v-.7z"/>
</symbol>
<symbol id="icon-menu" viewBox="0 0 24 28">
<path d="M24 21v2c0 .547-.453 1-1 1H1c-.547 0-1-.453-1-1v-2c0-.547.453-1 1-1h22c.547 0 1 .453 1 1zm0-8v2c0 .547-.453 1-1 1H1c-.547 0-1-.453-1-1v-2c0-.547.453-1 1-1h22c.547 0 1 .453 1 1zm0-8v2c0 .547-.453 1-1 1H1c-.547 0-1-.453-1-1V5c0-.547.453-1 1-1h22c.547 0 1 .453 1 1z"/>
</symbol>
</svg>
<div data-region="app">
<header data-region="banner">
<button data-nav-toggle data-toggle="button" aria-controls="nav" aria-pressed="false" type="button" data-toggle-synced="false">
<svg data-icon="menu" data-icon-size="nav-icon" ><title>menu</title><use xlink:href="#icon-menu" />
</svg>
</button>
<div class="project-title">
<a href="index.html" rel="home" class="project-name">Accoutrement: Color</a>
<span class="project-version">2.3.1</span>
</div>
</header>
<div data-region="container">
<nav data-region="nav" data-toggle="target" id="nav" data-target-id="nav" aria-expanded="false" data-auto-closing="false" data-auto-closing-on-any-click="false">
<form action="search.html">
<input type="text" name="q" placeholder="Search…" required minlength="3">
</form>
<div class="nav-subsection">
<h3 class="nav-home">
<a href="index.html" data-nav="is-not-active">Accoutrement: Color</a>
</h3>
<ul>
<li class="nav-item">
<a href="CHANGELOG.html" data-nav="is-not-active">Changelog</a>
</li>
<li class="nav-item">
<a href="CONTRIBUTING.html" data-nav="is-active">Contributing</a>
</li>
<li class="nav-item">
<a href="LICENSE.html" data-nav="is-not-active">MIT License</a>
</li>
</ul>
</div>
<div class="nav-subsection">
<ul>
<li class="nav-subsection">
<h3 class="nav-title">Public API</h3>
<ul>
<li class="nav-item">
<a href="a-config.html" data-nav="is-not-active">Configuration</a>
</li>
<li class="nav-item">
<a href="colors.html" data-nav="is-not-active">Accessing Colors</a>
</li>
<li class="nav-item">
<a href="contrast.html" data-nav="is-not-active">Contrast Utilities</a>
</li>
<li class="nav-item">
<a href="util.html" data-nav="is-not-active">Tint &<span class="widont"> </span>Shade</a>
</li>
</ul>
</li></ul>
</div>
<div class="nav-subsection">
<h3 class="nav-title">
External Links
</h3>
<ul>
<li class="nav-item">
<a href="http://oddbird.net/accoutrement-init/" data-nav="is-not-active">Accoutrement Init</a>
</li>
<li class="nav-item">
<a href="http://oddbird.net/accoutrement-layout/" data-nav="is-not-active">Accoutrement Layout</a>
</li>
<li class="nav-item">
<a href="http://oddbird.net/accoutrement-scale/" data-nav="is-not-active">Accoutrement Scale</a>
</li>
<li class="nav-item">
<a href="http://oddbird.net/accoutrement-type/" data-nav="is-not-active">Accoutrement Type</a>
</li>
</ul>
</div>
<aside class="footer-credit">
<a href="http://oddbird.net/herman/" class="footer-icon">
<svg data-icon="logo" data-icon-size="footer-logo" ><use xlink:href="#icon-logo" />
</svg>
</a>
<span>
Documented with
<a href="http://oddbird.net/herman/" class="footer-link">
Herman
</a>
</span>
<span>
by
<a href="http://oddbird.net/" class="footer-link">
OddBird
</a>
</span>
</aside>
</nav>
<main data-region="main">
<nav class="breadcrumb">
<a href="index.html" >Accoutrement: Color</a> »
<strong>Contributing</strong>
</nav>
<div data-page="CONTRIBUTING">
<div class="text-block">
<h1 id="contributing-to-accoutrement">Contributing to Accoutrement</h1>
<p>Bug reports and feature requests are welcome,
but code is even<span class="widont"> </span>better!</p>
<p>In all cases,
we ask you to follow the
<a href="http://sass-lang.com/community-guidelines">Sass community<span class="widont"> </span>guidelines</a>.</p>
<h2 id="development">Development</h2>
<p>Set up your environment
with the appropriate development<span class="widont"> </span>dependencies:</p>
<pre><code>yarn
</code></pre>
<p>As you work…</p>
<ul>
<li>Add or update any appropriate unit tests
in the <code>test</code> directory,
and make sure all tests are passing with <code>npm test</code></li>
<li>Add your changes to the <a href="CHANGELOG.md">changelog</a></li>
<li>Update or add inline documentation
using <a href="http://sassdoc.com/">SassDoc</a> as appropriate,
and compile the docs with <code>gulp sassdoc</code></li>
</ul>
<h2 id="committing">Committing</h2>
<p>Linting, testing, and documentation
should be done before every<span class="widont"> </span>commit:</p>
<pre><code>npm run commit
</code></pre>
<p>They can also be triggered<span class="widont"> </span>individually:</p>
<pre><code># lint
gulp sasslint
# test with mocha/true, and compile ag-test CSS
npm test
# compile docs
gulp sassdoc
</code></pre>
<p>Optionally use <code>npm run test-libsass</code> for js-only tests,
or <code>rake test</code> for ruby-only<span class="widont"> </span>environments.</p>
<p>Once you’ve fixed any final errors or typos,
commit your changes, and submit a pull<span class="widont"> </span>request!</p>
<h2 id="pull-requests">Pull Requests</h2>
<p>We use the <code>master</code> branch for production-ready code,
and side-branches for everything in-progress
or<span class="widont"> </span>up-for-debate.</p>
<p>When submitting a patch via pull<span class="widont"> </span>request:</p>
<ul>
<li>Write a clear, descriptive commit<span class="widont"> </span>message</li>
<li>Keep it simple: one bug fix or feature per pull<span class="widont"> </span>request</li>
</ul>
</div>
</div>
</main>
</div>
</div>
<script type="text/javascript" src="assets/webpack/runtime.min.js"></script>
<script type="text/javascript" src="assets/webpack/common.min.js"></script>
<script type="text/javascript" src="assets/webpack/app.min.js"></script>
</body>
</html>