-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
76065e7
commit f5f4c73
Showing
21 changed files
with
548 additions
and
327 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.