Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.29 KB

CONTRIBUTE.md

File metadata and controls

36 lines (27 loc) · 1.29 KB
Raw

Contributing

Feel free to contribute to this project and help it grow.

Author

Contributors

Bugs

If you find any bugs, please add them to the issues on the GitHub page and give any examples if possible.

Features

Please log any feature requests in the issues, or create a pull request if you have added the feature in.

Directory Structure

Project files and folder structure.

+- css          CSS for plugin and demo site
+- img          For any images used by the plugin / demo
+- js           Distribution files
  +- lib        Any libraries used
+- src          The plugin source which Grunt builds from

NodeJS and gulp

This project uses Node JS and gulp.

Once installed, use npm install in the project directory to install the required dependancies. This will create a node_modules folder with the dependancies. Please do not add this folder to Git.

When contributing, use the src/jquery.scrollUp.js file and run gulp complile the distribution files.