Skip to content

Commit

Permalink
Merge pull request #2 from Juicy/remove-bowerrc
Browse files Browse the repository at this point in the history
Remove .bowerrc (use polyserve instead)
  • Loading branch information
Mihai authored Jul 31, 2017
2 parents 7dfc99c + 9fcc97c commit bdffa99
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 4 deletions.
3 changes: 0 additions & 3 deletions .bowerrc

This file was deleted.

36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Contributing

We welcome and truly appreciate contribution in all forms - issues, pull requests, questions, or fancy examples of apps/elements build on to of your elements.

## Filing bugs

Our team heavily uses Github for all of our software management. We use Github issues to track all bugs and features.

If you find an issue, please do file it on the repository.

We love examples for addressing issues - issues with a Plunkr, [jsFiddle](http://jsfiddle.net), or [jsBin](http://jsbin.com) will be much easier for us to work on quickly. You can start with [this jsbin](http://jsbin.com/capequ/edit?html,output) which sets up the basics to demonstrate a Juicy element.

Occasionally we'll close issues if they appear stale or are too vague - please don't take this personally! Please feel free to re-open issues we've closed if there's something we've missed and they still need to be addressed.

## Developing the element

If you would like to start to fiddle with element's code, here is the flow we use.

- Make a local clone of this repo: `git clone [email protected]:Juicy/juicy-svg-injector.git`

In order to develop it locally we suggest to use [polyserve](https://npmjs.com/polyserve) tool to handle bower paths gently.

0. Go to the repo's directory: `cd juicy-svg-injector`
1. Install [bower](http://bower.io/) & [polyserve](https://npmjs.com/polyserve): `$ npm install -g bower polyserve`
2. Install local dependencies: `$ bower install`
3. Start development server `$ polyserve -p 8000`
4. Open the demo/preview: [http://localhost:8000/components/juicy-svg-injector/](http://localhost:8000/components/juicy-svg-injector/)

## Contributing Pull Requests

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -m 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Open corresponding issue if needed
6. Submit a pull request :D
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
# juicy-svg-injector
Loads a SVG inline in your HTML, using [SVGInjector](https://github.com/iconic/SVGInjector)

[Demo](http://juicy.github.io/juicy-svg-injector)
## Demo

[Check it live!](http://juicy.github.io/juicy-svg-injector)

## [Contributing and Development](CONTRIBUTING.md)

## License

Expand Down

0 comments on commit bdffa99

Please sign in to comment.