Browse Source

add Support and Pull requests to contrib;

README updates
pull/726/head
David DeSandro 11 years ago
parent
commit
bdc41e9cc1
  1. 25
      CONTRIBUTING.mdown
  2. 22
      README.mdown

25
CONTRIBUTING.mdown

@ -2,12 +2,23 @@
### Reduced test case required
All bug reports and problem issues require a reduced test case. See [CSS Tricks - Reduced Test Cases](http://css-tricks.com/reduced-test-cases/) on why they _"are the absolute, ... number one way to troubleshoot bugs."_
All bug reports and problem issues require a [**reduced test case**](http://css-tricks.com/reduced-test-cases/). Create one by forking any one of the [CodePen examples](http://codepen.io/desandro/tag/isotope-docs) from [the docs](http://isotope.metafizzy.co).
+ A reduced test case is an isolated example that demonstrates the bug or issue.
+ It contains the bare minimum HTML, CSS, and JavaScript required to demonstrate the bug. No extra functionality or styling.
+ Any one of the [CodePen examples](http://codepen.io/desandro/tag/isotope-docs) in [the docs](http://isotope.metafizzy.co) may be forked and used to build your reduced test case.
+ A link to your site is **not** a reduced test case.
+ Until you provide a reduced test case, your issue will be closed.
+ A reduced test case clearly demonstrates the bug or issue.
+ It contains the bare minimum HTML, CSS, and JavaScript required to demonstrate the bug.
+ A link to your production site is **not** a reduced test case.
Reduced test cases dramatically help both you and me. They help you identify the issue at hand and understand your own code. On my side, they greatly reduce the amount of time spent resolving the issue.
Providing a reduced test case is the best way to get your issue addressed. Without a reduced test case, your issue may be closed.
## Support
+ Having trouble setting up Isotope?
+ Running into a time-consuming problem?
[CodersClan has a dedicated support forum for Isotope](https://www.codersclan.net/?repo_id=1), where you can get personal support from experienced developers.
#### [Get support on CodersClan](https://www.codersclan.net/?repo_id=1)
## Pull requests
Contributions are welcome! Please note: your code may be used as part of a commercial product if merged. Be clear about what license applies to your patch. [The MIT license](http://choosealicense.com/licenses/mit/) or [public domain unlicense](http://choosealicense.com/licenses/unlicense/) are permissive, and allow integration of your patch into Isotope as part of a commercial product.

22
README.mdown

@ -1,6 +1,6 @@
# Isotope
_Filter and sort magical layouts_
_Filter & sort magical layouts_
See [isotopejs.com](http://isotopejs.com) for complete docs and demos.
@ -18,7 +18,7 @@ If you are cool with the command line, install Isotope as a [Bower](http://bower
bower install isotope
```
## Isotope
## License
Isotope may be used in commercial projects and applications with the one-time purchase of a commercial license. If you are paid to do your job, and part of your job is implementing Isotope, a commercial license is required.
@ -31,8 +31,8 @@ For non-commercial, personal, or open source projects and applications, you may
### In JavaScript
``` js
var container = document.querySelector('#container');
var iso = new Isotope( container, {
// jQuery
$('#container').isotope({
// options...
itemSelector: '.item',
masonry: {
@ -41,10 +41,10 @@ var iso = new Isotope( container, {
});
```
Or with jQuery
``` js
$('#container').isotope({
// vanilla JS
var container = document.querySelector('#container');
var iso = new Isotope( container, {
// options...
itemSelector: '.item',
masonry: {
@ -65,6 +65,12 @@ Add a class of `js-isotope` to your element. Options can be set in JSON in `data
</div>
```
## Support
[CodersClan has a dedicated support forum for Isotope](https://www.codersclan.net/?repo_id=1), where you can get personal support from experienced developers.
#### [Get support on CodersClan](https://www.codersclan.net/?repo_id=1)
* * *
Copyright (c) 2013 Metafizzy
By [Metafizzy](http://metafizzy.co)

Loading…
Cancel
Save