Contributing.md #1

When submitting a PR, your chance of acceptance increases if you do the following:

  • Code style is consistent with existing in the file.
  • Tests are passing (client and server).
  • You add a test for the failing issue you are fixing.
  • Code changes are focused on the area of discussion.
  • Do not rebuild the distribution files or increment version numbers.
When submitting a PR, your chance of acceptance increases if you do the following:

* Code style is consistent with existing in the file.
* Tests are passing (client and server).
* You add a test for the failing issue you are fixing.
* Code changes are focused on the area of discussion.
* Do not rebuild the distribution files or increment version numbers.
# Change User Description Committed
#1 19553 swellard Move and rename clients
//guest/perforce_software/helix-web-services/main/source/clients/2016.1.0/javascript/node_modules/superagent/Contributing.md
#1 18810 tjuricek First-pass at JavaScript client SDK.

JavaScript requires Node with Gulp to "browserfy" the library. It's the easiest way I found to use the swagger-js project; bundle up a wrapping method.

There is no JavaScript reference guide. The swagger-js doesn't really document what they do very well, actually.

Overall I'm not particularly impressed by swagger-js, it was hard to even figure out what the right method syntax was. We may want to invest time in doing it better.

This required setting CORS response headers, which are currently defaulted to a fairly insecure setting.