Permalink
Browse files

editorconf, contributing, license, update readme

- add .editorconfig file
- add contributing.md file
- add license info
- update readme to reflect these changes
  • Loading branch information...
Jeff Escalante
Jeff Escalante committed Jan 9, 2014
1 parent 87a45f4 commit 0fa052abb808ab795ae52c92e937e287fabf9085
Showing with 53 additions and 19 deletions.
  1. +10 −0 .editorconfig
  2. +28 −0 contributing.md
  3. +10 −0 license.md
  4. +5 −19 readme.md
View
@@ -0,0 +1,10 @@
# This file is for unifying the coding style for different editors and IDEs
# editorconfig.org
root = true
[*]
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
View
@@ -0,0 +1,28 @@
# Contributing to Share Button
Hello there! First of all, thanks for being interested in share-button and helping out. We all think you are awesome, and by contributing to open source projects, you are making the world a better place. That being said, there are a few ways to make the process of contributing code to share-button smoother, detailed below:
### Filing Issues
If you are opening an issue about a bug, make sure that you include clear steps for how we can reproduce the problem. If we can't reproduce it, we can't fix it. If you are suggesting a feature, make sure your explanation is clear and detailed.
### Getting Set Up
- Clone the project down
- Make sure [nodejs](http://nodejs.org) has been installed and is above version `0.10.x`
- Run `npm install`
- Make changes to the files in the `src` folder
- Run `cake build` to build the js files into `dist` one time
- Run `cake watch` to watch the src folder and rebuild on change
### Testing
This project is constantly evolving, and to ensure that things are secure and working for everyone, we need to have tests. If you are adding a new feature, please make sure to add a test for it. That being said, tests for this library are tough - at very least make sure to visually confirm that it's working using index.html in the root.
To run the test suite, make sure you have installed [mocha](http://visionmedia.github.io/mocha/) (`npm install mocha -g`), then you can use the `npm test` command to run them.
### Commit Cleanliness
It's ok if you start out with a bunch of experimentation and your commit log isn't totally clean, but before any pull requests are accepted, we like to have a nice clean commit log. That means [well-written and clear commit messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) and commits that each do something significant, rather than being typo or bug fixes.
If you submit a pull request that doesn't have a clean commit log, we will ask you to clean it up before we accept. This means being familiar with rebasing - if you are not, [this guide](https://help.github.com/articles/interactive-rebase) by github should help you to get started, and feel free to ask us anything, we are happy to help.
View
@@ -0,0 +1,10 @@
License (MIT)
-------------
Copyright (c) 2013 Jeff Escalante, Carrot Creative
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.
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.
View
@@ -99,25 +99,11 @@ share.self; // returns an instance of the jquery object it was called on (fo
This will likely become more powerful down the line as this project continues to be developed - open an issue if there's anything you wish the api would have.
### Contributing
Pretty simple project, all you need to do to set up for build is the following:
- `npm install coffee-script -g`
- inside this folder, `npm install`
- edit any of the files in `src` and run `cake build` to build them
### Testing
We are in process of adding a small test suite that covers the basic functionality of this plugin to make sure nothing is broken. If you send a pull request, it would be awesome if you also wrote a test for your feature. The testing interface is very simple, it just uses [should.js](https://github.com/visionmedia/should.js/) and jquery. Here's how to get set up for testing:
- `npm install mocha -g`
- `npm install coffee-script -g`
- inside this folder, `npm install`
- `mocha` or `npm test` will run the tests
The tests rely on the following libraries, for which documentation is linked: [mocha](http://visionmedia.github.io/mocha/), [should](https://github.com/visionmedia/should.js/), [zombie](http://zombie.labnotes.org/), [q](https://github.com/kriskowal/q)
### Inspiration
This project was inspired by [this dribbble shot](http://dribbble.com/shots/1072278) and [this cssdeck experiment](http://cssdeck.com/labs/css-social-share-button) - huge props to these two guys for some incredible ideas and work.
### Contributing and License
- Contributing Guidelines can be found [here](contributing.md)
- Licenced uncer MIT - [details here](license.md)

0 comments on commit 0fa052a

Please sign in to comment.