Skip to content
This repository has been archived by the owner on May 3, 2021. It is now read-only.

Commit

Permalink
Callback now acts like an on_ready event. Added on_error event. Remov…
Browse files Browse the repository at this point in the history
…ed get_data. Improved docs, README.md and CONTRIBUTING.md
  • Loading branch information
jsanahuja committed Jul 9, 2020
1 parent f6ed7cb commit 514c379
Show file tree
Hide file tree
Showing 8 changed files with 111 additions and 126 deletions.
19 changes: 11 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue,
When contributing to this repository, please **first discuss the change you wish to make via issue**,
email, or any other method with the owners of this repository before making a change.

## Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the documentation with the details of changes to the usage and behavior.
3. Increase the version numbers in every file where the version number is present to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.
1. Install all the dependencies using `npm install`
2. Make your changes and test them. Note that depending on your changes you may also have to modify existing tests or create new ones.
3. **Run the tests** using `npm run test`
4. **Build** the minified version using `npm run build`
5. **Update the docs** (index.html) with the changes. If it is a new feature ensure to include it in the first example.
6. **Increase the version numbers in every file** where the version number is present to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).

## Optional

Consider making your changes also in [jquery.instagramFeed](https://github.com/jsanahuja/jquery.instagramFeed).
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,10 @@ Instagram Feed without using the instagram API. Neither jQuery!

This is a vanilla JavaScript version of the original [jquery.instagramFeed](https://github.com/jsanahuja/jquery.instagramFeed)

## Documentation

[Full documentation and examples here](https://www.sowecms.com/demos/InstagramFeed)

## Contributing

Read and follow the [CONTRIBUTING.md](./CONTRIBUTING.md) before sending any pull request.
2 changes: 1 addition & 1 deletion dist/InstagramFeed.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 514c379

Please sign in to comment.