Skip to content

Commit

Permalink
Merge pull request #505 from corysimmons/master
Browse files Browse the repository at this point in the history
7.0.0: Make Jeet Great Again
  • Loading branch information
corysimmons committed Oct 25, 2016
2 parents 98dfe2a + 2a24414 commit 47e2c0c
Show file tree
Hide file tree
Showing 73 changed files with 1,296 additions and 1,633 deletions.
18 changes: 10 additions & 8 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@ We welcome all contribution from the community, but we have a few guidelines to
### Getting Jeet set up locally

1. [Fork Jeet](https://github.com/mojotech/jeet/fork).
1. `git clone https://github.com/YOUR-USERNAME/jeet` to get a local copy of your fork.
1. `git clone` YOUR fork of Jeet to get a local copy.
1. Run `git remote add upstream https://github.com/mojotech/jeet`. This will add another remote, named upstream, that points to the official Jeet repository. This will help with keeping your forks up to date with Jeet's master branch.

### Making changes

1. Create a new branch following [Git Flow](http://nvie.com/posts/a-successful-git-branching-model/)
1. Checkout your new branch and commit your changes. Separate edits into [clean](https://github.com/erlang/otp/wiki/Writing-good-commit-messages), non-breaking, commits.
1. Create a new branch using `git checkout -b my-new-branch`.
1. Do some work, commit some changes. Separate edits into [clean](https://github.com/erlang/otp/wiki/Writing-good-commit-messages), non-breaking, commits, if possible. At the very least, *try* to separate out your work into logical chunks. Removing trailing whitespace throughout the project? Good commit. Removing whitespace **and** changing indentation? Bad commit. Typically if you can say "and" it can be broken out into separate commits.
1. Try not to submit a HUGE PR. Small PRs are best for everyone. Good for maintainers because they don't have to dig through 50-million lines of code to ensure everything is proper. Good for you so you don't do a ton of work just to get it rejected. :(

### Tests

1. Making big changes or adding a new feature entirely? Make sure you add tests for new mixins/functions. Simply follow the structure found in `/tests`.
1. Run the tests with `npm run test` and make sure they all pass.
1. Fork the [Scss](http://codepen.io/corysimmons/pen/EkcDm) and [Stylus](http://codepen.io/corysimmons/pen/ArLdm) CodePens and make sure the changes behave as expected.
1. Making big changes or adding a new feature entirely? Make sure you add tests for new mixins/functions. If you're not good at writing tests, a maintainer can work with you.
1. Run the tests with `npm test` and make sure they all pass.

### Opening a pull request

1. Push your changes to your fork by running `git push origin your-branch-name`.
1. Open a [pull request](https://help.github.com/articles/creating-a-pull-request), give it a clear title and explain what your changes do. Provide a link to your CodePen so we can check out the changes.
1. Be prepared to update your PR based on feedback. If you make updates, run `git push origin your-branch-name -f` on your branch branch to update the PR on Github.
1. Open a [pull request](https://help.github.com/articles/creating-a-pull-request), give it a clear title and explain what your changes do.
1. Be prepared to update your PR based on feedback. If you make updates, run `git push origin your-branch-name -f` on your branch branch to update the same PR you received feedback on.
1. Bask in the warm glow of being an amazing person.

### Keeping unmerged forks up to date with master
Expand All @@ -36,6 +36,8 @@ If your fork is taking a while to get merged, you might end up getting behind Je

1. `git fetch upstream master` This will give you all the latest updates from Jeet's master branch.
1. Run `git rebase upstream/master` while inside your feature branch. This will add all the new commits **before** yours, so it's as if you made the changes to the latest codebase.
1. There might be merge conflicts. In which case, open them in an editor then pick and choose what changes to keep.

## Notes

- New to Git? Read this great/free [book](http://git-scm.com/documentation).
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,7 @@ Icon
# Files that might appear on external disk
.Spotlight-V100
.Trashes


### Custom ###
todo.md
8 changes: 0 additions & 8 deletions .npmignore

This file was deleted.

2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
language: node_js
node_js:
- "0.10"
- "6.6.0"
153 changes: 0 additions & 153 deletions CHANGELOG.md

This file was deleted.

4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014 MojoTech
Copyright (c) 2016 MojoTech

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
Expand All @@ -17,4 +17,4 @@ 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.
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
51 changes: 24 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,37 @@
<p align="center">
<img width="190px" src="https://mojotech.github.io/jeet/img/jeet-logo-color.svg" title="Jeet Grid System">
</p>
<img width="220px" src="https://mojotech.github.io/jeet/img/jeet-logo-color.svg" title="Jeet Grid System">

<p align="center">
<img src="https://img.shields.io/npm/v/jeet.svg">
<img src="https://img.shields.io/bower/v/jeet.svg">
<img src="http://img.shields.io/npm/dm/jeet.svg">
<a href="https://gitter.im/mojotech/jeet"><img src="https://img.shields.io/gitter/room/nwjs/nw.js.svg?maxAge=2592000?style=flat-square"></a>
</p>
<a href="https://gitter.im/mojotech/jeet"><img src="https://img.shields.io/gitter/room/nwjs/nw.js.svg?maxAge=2592000?style=flat-square"></a>
<img src="https://img.shields.io/npm/v/jeet.svg">
<img src="http://img.shields.io/npm/dm/jeet.svg">

# This is a rollback to 6.1.2!
[Jeet](http://jeet.gs) is a simple fractional grid system for **[Sass](scss)** and **[Stylus](styl)**.

> ❗️ Jeet 6.1.3 and 6.1.4 introduced breaking changes that have caused a lot of issues. This is a rollback to 6.1.2. Moving forward, we will strictly adhere to semver and apologize for any broken builds. 🤕 Thanks for sticking with us as we grow!
Learn the [API](docs) in minutes and begin tossing together grids.

---
Check this out:

[Jeet](http://jeet.gs) is the most advanced, yet intuitive, grid system on the market today.
```fish
npm install -D jeet
```

By making use of the power of pre-processors, we can now pass real fractions (or float numbers) as context that generates a percentage based width and gutter for grids. We're able to do this while maintaining a consistently sized infinitely nestable gutter.
```scss
@import 'node_modules/jeet/scss/index';

Check out [this presentation](http://corysimmons.github.io/presentations/the-rise-of-ratio-grids) to learn more about what sets Jeet above other grid systems, then enjoy one of Jeet's many pre-processor flavors:
.container {
@include center();
}

- [Stylus](stylus)
- [SCSS](scss)
.container div {
@include column(1/3);
}
```

Want to sandbox it right this very second? Fork an [SCSS](http://bit.ly/jeet6-scss) or [Stylus](http://bit.ly/jeet6-stylus) example on CodePen.
Jeet functions accept fractions (or float numbers) and generates a percentage width and gutter for grids. We're able to do this while maintaining a consistently-sized, infinitely-nestable, gutter (so long as you provide the parent element's fraction as context).

Explore [Jeet Integrations](https://github.com/mojotech/jeet/wiki/Jeet-Integrations) to see some community-backed plugins to your favorite frameworks and libraries.
The API is documented in Sass, but we've worked hard to make the API *very* similar in both preprocessors. `@include column(1/2);` in SCSS would be `column(1/2)` in Stylus, ya dig?

#### Browser Support
- IE9+ and all major browsers without polyfills like Selectivizr
- With a nice boilerplate like [Boy](http://github.com/corysimmons/boy), seamless and responsive in IE7+ ([gallery](http://imgur.com/a/Z0YPD))

---
Explore [Official Integrations](docs/integrations) to see some community-backed plugins to your favorite frameworks and libraries.

##### Jeet is curated by loving hands at...
<a href="http://mojotech.com"><img width="140px" src="https://mojotech.github.io/jeet/img/mojotech-logo.svg" title="MojoTech's Hiring"></a> <sup>(psst, [we're hiring](http://www.mojotech.com/jobs))</sup>
#### Browser Support

##### Thanks to all the [awesome contributors](https://github.com/mojotech/jeet/graphs/contributors)
- IE9+ without help. IE8+ with Selectivizr. Obviously always use Autoprefixer.
33 changes: 0 additions & 33 deletions bower.json

This file was deleted.

7 changes: 7 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Jeet Docs

Jeet is available in Sass and Stylus. Sass is more popular, so the docs are written solely in Sass.

The API is *very* similar so if you're using Stylus you should be able to tell what's what.

Officially maintained [integrations](integrations) are available.

0 comments on commit 47e2c0c

Please sign in to comment.