bourbon - npm Package Compare versions

Comparing version 4.2.6 to 5.0.0-beta.4

CONTRIBUTING.md

@@ -1,37 +0,63 @@
-We love pull requests from everyone. By participating in this project, you
-agree to abide by the thoughtbot [code of conduct]. Here’s a quick guide:
+# Contributing
 
-[code of conduct]: https://thoughtbot.com/open-source-code-of-conduct
+By participating in this project, you agree to abide by the thoughtbot
+[code of conduct](https://thoughtbot.com/open-source-code-of-conduct).
 
-1. Fork the repository.
-2. Make your changes in a topic branch.
-3. Squash your commits into a single one (more on that [here](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)).
-4. Rebase against `origin/master`, push to your fork and submit a pull request.
-5. If you are writing a new feature please add documentation for it by making another pull request to the `gh-pages` branch.
+## Pull Requests
 
-At this point you’re waiting on us. We like to at least comment on, if not
-accept, pull requests within three business days (and, typically, one business
-day). We may suggest some changes or improvements or alternatives.
+We welcome pull requests from everyone. Here’s a quick guide:
 
-Some things that will increase the chance that your pull request is accepted:
+1. [Fork the repository][fork] and clone to your machine.
+1. Run `bundle install`.
+1. Make sure the tests pass: `bundle exec rake`.
+1. Make your change, following our style guide (below). Write tests. Make sure
+   the tests pass: `bundle exec rake`.
+1. Write a [good commit message][commit]. Push to your fork and
+   [submit a pull request][pr]. If [Hound] catches style violations, fix them.
+1. Wait for us. We try to at least comment on pull requests within one week. We
+   may suggest changes.
 
-* Fix a bug, refactor code or expand an existing feature.
-* Use the right syntax and naming conventions.
-* Update parts of the documentation that are affected by your contribution.
+[fork]: https://github.com/thoughtbot/bourbon/fork
+[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[pr]: https://github.com/thoughtbot/bourbon/compare/
+[hound]: https://houndci.com
 
-**Git Commit Messages**
+### Style Guide
 
-* Capitalize your commit messages.
-* Start your message with a verb.
-* Use present tense.
-* Refer to the issue/PR number in your squashed commit message.
+Bourbon uses Sass’s SCSS syntax and aligns to
+[thoughtbot’s style guides][sass guide]. High-level notes:
 
-**SCSS Style Guide**
+- Use two-space indentation (no tabs).
+- Use double quotation marks.
+- Use hyphens when naming things: `hide-visually` rather than `hide_visually` or
+  `hideVisually`.
+- Use one space between property and value: `width: 20px` rather than
+  `width:20px`.
+- Names should be descriptive and aim for clarity over brevity:
+  `$all-text-inputs-hover` rather than `$inputshover` or `$alltxthvr`.
+- Order CSS declarations alphabetically.
+- No trailing whitespace.
 
-* Two spaces, no tabs.
-* Dashes instead of underscores or camel case: `linear-gradient` **not** `linear_gradient` or `linearGradient`
-* Names should be descriptive and written in full-words: `$all-text-inputs-hover` **not** `$hover` or `$alltxthvr`
-* Space between property and value: `width: 20px` **not** `width:20px`
-* Declarations within a block should be ordered alphabetically.
-* Blank lines between rules.
-* No trailing whitespace. Blank lines should not have any space.
+[sass guide]: https://github.com/thoughtbot/guides
+[SCSS-Lint]: https://github.com/brigade/scss-lint
+
+### Documentation
+
+We use [SassDoc] to document Bourbon. [Annotations] should be ordered:
+
+- `@link`
+- `@see`
+- `@type`
+- `@argument`
+- `@property`
+- `@return`
+- `@example`
+- `@require`
+- `@access`
+- `@since`
+- `@author`
+- `@deprecated`
+- `@todo`
+
+[SassDoc]: http://sassdoc.com
+[Annotations]: http://sassdoc.com/annotations

index.js

@@ -1,7 +0,7 @@
-var path = require('path');
+var path = require("path");
 
 module.exports = {
   includePaths: [
-    path.join(__dirname, 'app/assets/stylesheets')
+    path.join(__dirname, "core")
   ]
 };

LICENSE.md

 The MIT License (MIT)
 
-Copyright © 2011–2015 [thoughtbot, inc.](http://thoughtbot.com)
+Copyright © 2011 [thoughtbot, inc.](http://thoughtbot.com)
 
@@ -5,0 +5,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy

package.json

 {
-  "name": "bourbon",
-  "version": "4.2.6",
+  "author": {
+    "name": "thoughtbot",
+    "url": "http://thoughtbot.com"
+  },
+  "bugs": {
+    "url": "https://github.com/thoughtbot/bourbon/issues"
+  },
   "description": "A simple and lightweight mixin library for Sass.",
+  "eyeglass": {
+    "needs": "*",
+    "exports": "eyeglass-exports.js"
+  },
+  "homepage": "http://bourbon.io",
   "keywords": [
@@ -12,16 +22,5 @@ "css",
   ],
-  "homepage": "http://bourbon.io",
-  "bugs": {
-    "url": "https://github.com/thoughtbot/bourbon/issues"
-  },
-  "eyeglass": {
-    "needs": "*",
-    "exports": "eyeglass-exports.js"
-  },
   "license": "MIT",
-  "author": {
-    "name": "thoughtbot",
-    "url": "http://thoughtbot.com"
-  },
   "main": "index.js",
+  "name": "bourbon",
   "repository": {
@@ -32,4 +31,5 @@ "type": "git",
   "scripts": {
-    "test": "echo \"No test specified\""
-  }
+    "test": "bundle exec rake"
+  },
+  "version": "5.0.0-beta.4"
 }

README.md

@@ -21,3 +21,3 @@ [![Bourbon](http://images.thoughtbot.com/bourbon/bourbon-logo.svg)](http://bourbon.io)
 
-- [Sass](https://github.com/sass/sass) 3.4+ or [LibSass](https://github.com/sass/libsass) 3.1+
+- [Sass](https://github.com/sass/sass) 3.4+ or [LibSass](https://github.com/sass/libsass) 3.3+
 
@@ -36,3 +36,3 @@ ## Installation
 
-2. Install the Bourbon library into the current directory:
+1. Install the Bourbon library into the current directory:
 
@@ -49,3 +49,3 @@ ```bash
 
-3. Import Bourbon at the beginning of your stylesheet:
+1. Import Bourbon at the beginning of your stylesheet:
 
@@ -58,3 +58,3 @@ ```scss
 
-## Installation for Ruby on Rails 3.1+
+## Installation for Ruby on Rails 4.2+
 
@@ -67,3 +67,3 @@ 1. Add Bourbon to your Gemfile:
 
-2. Then run:
+1. Then run:
 
@@ -74,3 +74,3 @@ ```bash
 
-3. Restart your server and rename `application.css` to `application.scss`:
+1. Restart your server and rename `application.css` to `application.scss`:
 
@@ -81,5 +81,5 @@ ```bash
 
-4. Delete _all_ Sprockets directives in `application.scss` (`require`, `require_tree` and `require_self`) and use Sass’s native `@import` instead. ([why?](http://pivotallabs.com/structure-your-sass-files-with-import))
+1. Delete _all_ Sprockets directives in `application.scss` (`require`, `require_tree` and `require_self`) and use Sass’s native `@import` instead. ([why?](http://pivotallabs.com/structure-your-sass-files-with-import))
 
-5. Import Bourbon at the beginning of `application.scss`. All additional stylesheets should be imported below Bourbon:
+1. Import Bourbon at the beginning of `application.scss`. All additional stylesheets should be imported below Bourbon:
 
@@ -102,5 +102,5 @@ ```scss
 
-2. If you’re using [Eyeglass](http://eyeglass.rocks), skip to Step 3. Otherwise, you’ll need to add Bourbon to your node-sass `includePaths` option. `require("bourbon").includePaths` is an array of directories that you should pass to node-sass. How you do this depends on how node-sass is integrated into your project.
+1. If you’re using [Eyeglass](http://eyeglass.rocks), skip to Step 3. Otherwise, you’ll need to add Bourbon to your node-sass `includePaths` option. `require("bourbon").includePaths` is an array of directories that you should pass to node-sass. How you do this depends on how node-sass is integrated into your project.
 
-3. Import Bourbon into your Sass files:
+1. Import Bourbon into your Sass files:
 
@@ -119,3 +119,3 @@ ```scss
 
-2. Reinstall the Bourbon gem, using the `-v` flag to specify the version you need:
+1. Reinstall the Bourbon gem, using the `-v` flag to specify the version you need:
 
@@ -126,3 +126,3 @@ ```bash
 
-3. Follow the [instructions above](#installation) to install Bourbon into your project.
+1. Follow the [instructions above](#installation) to install Bourbon into your project.
 
@@ -146,20 +146,25 @@ ## Browser support
 
+## Contributing
+
+See the [contributing] document. Thank you, [contributors]!
+
+  [contributing]: CONTRIBUTING.md
+  [contributors]: https://github.com/thoughtbot/bourbon/graphs/contributors
+
 ## License
 
-Copyright © 2011–2015 [thoughtbot, inc](http://thoughtbot.com).
-Bourbon is free software,
-and may be redistributed under the terms specified in the [license](LICENSE.md).
+Bourbon is copyright © 2011 [thoughtbot, inc.][thoughtbot] It is free software, and may be redistributed under the terms specified in the [license].
 
-## About thoughtbot
+  [license]: LICENSE.md
 
-[<img src="http://thoughtbot.github.io/images/signature.svg" width="250" alt="thoughtbot logo">][hire]
+## About
 
-Bourbon is maintained and funded by thoughtbot, inc.
-The names and logos for thoughtbot are trademarks of thoughtbot, inc.
+Bourbon is maintained by Tyson Gach and the thoughtbot design team. It is funded by [thoughtbot, inc.][thoughtbot] and the names and logos for thoughtbot are trademarks of thoughtbot, inc.
 
-We love open source software!
-See [our other projects][community] or
-[hire us][hire] to design, develop, and grow your product.
+[<img src="http://thoughtbot.github.io/images/signature.svg" width="250" alt="thoughtbot logo">][thoughtbot]
 
-[community]: https://thoughtbot.com/community?utm_source=github
-[hire]: https://thoughtbot.com/hire-us?utm_source=github
+We love open-source software! See [our other projects][community] or [hire us][hire] to design, develop, and grow your product.
+
+  [thoughtbot]: https://thoughtbot.com?utm_source=github
+  [community]: https://thoughtbot.com/community?utm_source=github
+  [hire]: https://thoughtbot.com/hire-us?utm_source=github

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

160

increased by3.23%

Worsened metrics

Total package byte prevSize

54632

decreased by-43.84%

Number of package files

48

decreased by-43.53%

No dependency changes