@workfront/api-constants
Version:
Definitions for all constants which can be used to interact with Workfront API
51 lines (32 loc) • 2.2 kB
Markdown
# @workfront/api-constants
[![NPM version][npm-version-image]][npm-url] [![NPM downloads][npm-downloads-image]][npm-url] [![Apache v2 License][license-image]][license-url]
Definitions for all constants which can be used to interact with Workfront API
## Usage
Published package contains definitions of constants in both UMD (ES5 syntax) and ES2015 format.
1) `umd/constants.js` - Contains definitions for all Workfront API constants in UMD format (ES5 syntax)
2) `constants.js` - Contains definitions for all Workfront API constants in ES2015 format
3) `constants.d.ts` - Contains typings for exported constants
## Contributing
We welcome contributions of all kinds from anyone. It can be either new example or fix or documentation improvement. Please read these guidelines:
### Bug Reports
A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you! Please make sure to check these points to make a good bug report:
1. **Use the GitHub issue search** — check if the issue has already been
reported.
2. **Isolate the problem** — ideally create a [reduced test
case](https://css-tricks.com/reduced-test-cases/).
3. A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.
### Feature requests
Feature requests are welcome. But take a moment to find out whether your idea
fits with the scope and aims of the project. It's up to *you* to make a strong
case to convince the project's developers of the merits of this feature. Please
provide as much detail and context as possible.
## License
Copyright (c) 2016 Workfront
Licensed under the Apache License, Version 2.0.
See the top-level file `LICENSE` and
(http://www.apache.org/licenses/LICENSE-2.0).
[license-image]: http://img.shields.io/badge/license-APv2-blue.svg?style=flat
[license-url]: LICENSE
[npm-url]: https://www.npmjs.org/package/@workfront/api-constants
[npm-version-image]: https://img.shields.io/npm/v/@workfront/api-constants.svg?style=flat
[npm-downloads-image]: https://img.shields.io/npm/dm/@workfront/api-constants.svg?style=flat