Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.35 KB
Raw

Contributing

Important notes

Please don't edit files in the dist subdirectory as they are generated via Grunt. You'll find source code in the src subdirectory!

Code style

See JavaScript coding conventions of Interactive Pioneers.

Bug reports, suggestions

  • File all your issues, feature requests here
  • If filing a bug report, follow the convention of Steps to reproduce / What happens? / What should happen?
  • If you're a developer, write a failing test instead of a bug report and send a Pull Request

Code

  1. Fork it ( https://github.com/[my-github-username]/iptools-jquery-offcanvas/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Install dependencies (npm i)
  4. Develop your feature by concepts of TDD, see Tips
  5. Commit your changes (git commit -am 'Add some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create a new Pull Request

Tips

Following tasks are there to help with development:

  • npm run grunt watch listens to source, runs full QA and live-reloads browser
  • npm start listens source, runs tests
  • nmp test runs full QA
  • npm run grunt build minifies source to dist/