Skip to content

Latest commit

 

History

History
52 lines (29 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

52 lines (29 loc) · 1.65 KB
Raw

Contributing to Form

There are several ways of contributing to Form.

  • Help improve the documentation
  • Report an issue by creating an issue on Github.
  • Help with any open issues. The most accurate and clearly written issues are more likely to be fixed sooner.
  • Contribute to the code base.

Reporting an issue

To save everyone time and make it much more likely for your issue to be understood, worked on and resolved quickly, it would help if you're mindful of How to Report Bugs Effectively when pressing the "Submit new issue" button.

Contributing to the code base

Pick an issue to fix, or pitch new features. To avoid wasting your time, please ask for feedback on feature suggestions with an issue.

Run the tests

On Node

$ npm test

In the browser

Some tests needs working XHR to pass. To run the tests over an HTTP server, run

$ grunt bt:test:qunit:server
Testing in development

Open localhost:7755/ in a browser which is done via browserify. You can also debug test files in the browser. The files are also watched so the build will recompile when you make edits to them.

Do a build

To do a production-like build, run:

$ grunt bt:build

Which will build the project into the dist folder.

To do a local build and have the files get watched as you edit them, run:

$ grunt bt:build:local

Publish the JSdocs

$ grunt publish_docs