Skip to content

Latest commit

 

History

History
131 lines (77 loc) · 5.11 KB

CONTRIBUTING.md

File metadata and controls

131 lines (77 loc) · 5.11 KB

Contributing

Project Files

The following gives a brief description for each file's purpose.

css

Contains stylesheets for the demo theme and demo overlay.

scripts

Contains the compiled sequence.js and its minified version sequence.min.js. If you want to develop sequence.js please do so in the version found in src. Also contains the following third-party dependencies:

  • hammer.min.js - Used for touch support
  • imagesloaded.pkgd.min.js - Used for preloading images
  • respond.min.js - Used to make a Sequence theme responsive in Internet Explorer 7 and 8
  • sequence-theme.intro.js - Options and inititate code to start Sequence on the demo theme

src

Contains the development version of sequence.js. This is the file to change should you wish to work on the core Sequence library.

tests

Contains a test file and test themes. Head to tests/index.html.

.gitignore

Lists files/directory that Git should ignore.

bower.json

Lists Sequence's Bower details and the dependencies it uses.

CHANGELOG.md

Contains history of all the changes made to Sequence.

CONTRIBUTING.md

The very file you are reading right now!

DOCUMENTATION.md

Contains everything you need to know about working with Sequence.

Gruntfile.js

Describes the automated tasks used for developing Sequence.

index.html

The demo theme for Sequence.

LICENSE.md

License information for Sequence.

package.json

Lists Sequence's NPM details and the dependencies it uses during development.

README.md

The intro to Sequence.

Using Grunt

The Sequence project uses Grunt to automate useful tasks. With Grunt installed (see Grunt's Getting Started), use the following command to install Sequence's project dependencies:

npm install

Once Sequence's project dependencies have installed you can use the commands grunt, grunt run, grunt jshint.

grunt

This is the default command that will start a development environment with the following automated tasks:

  • Starts a livereload session that will reload your browser whenever a file is changed (be sure to install livereload)
  • Opens your browser and navigates to http://localhost:8000/
  • Sets up a watch task to run the following sub-tasks:
    • Update the version number in sequence.js and bower.json when changed in package.json
    • Copy src/sequence.js to the scripts directory and create an uglify (minified) copy as scripts/sequence.min.js
    • Process any .scss files found in the scss directory, autoprefix them and then copy to css and minify

You only need to run grunt per each development session as the watch task will continue to operate as you modify files.

grunt run

The grunt run command is a manual version of the watch sub tasks listed for the grunt command.

grunt jshint

The grunt jshint command will run a command line version of JSHint that suggests improvements that can be made in src/sequence.js.

Submitting a Bug

Please note that the issue tracker is for bugs only -- either relating to sequence.js, its dependencies, or official Sequence themes. For support on your own Sequence themes, please use StackOverflow with the tags sequence and/or sequencejs.

Before reporting a bug

  1. Search issue tracker for similar issues.
  2. Try the latest dev branch version of sequence.js.

How to report a bug

  1. Specify the version number of the sequence.js library where the bug occurred (you'll find it toward the top of sequence.js, sequence.min.js, or package.json).
  2. Specify your browser version and operating system (for example, Chrome 35, Windows 8)
  3. Describe the problem in detail. Explain what happened, and what you expected would happen.
  4. Provide a small test-case via CodePen, JSBin, JSFiddle, or similar. If a test-case is not possible, provide a link to a live version of your application.
  5. If helpful, include a screenshot. Annotate the screenshot for clarity.

Submitting a Pull Request

  1. Make sure you have a GitHub account.
  2. Fork the repository on GitHub.
  3. Make changes to your clone of the repository.
  4. Submit a pull request.

Submit Your Theme to The Showcase

If you've created a Sequence theme you'd like the world to see, submit it to our showcase and it may get featured on the SequenceJS.com website!