https://github.com/dojo/dojo-package-template
Dojo 2 - template to clone for creating packages (internal use)
https://github.com/dojo/dojo-package-template
Last synced: 9 months ago
JSON representation
Dojo 2 - template to clone for creating packages (internal use)
- Host: GitHub
- URL: https://github.com/dojo/dojo-package-template
- Owner: dojo
- License: other
- Created: 2015-04-14T15:47:37.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T12:28:02.000Z (over 2 years ago)
- Last Synced: 2025-05-04T02:39:02.299Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 156 KB
- Stars: 6
- Watchers: 30
- Forks: 18
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# dojo-<< package-name >>
TODO: Replace with a description of this package
## Features
TODO: Add sections on features of this package
## How do I use this package?
TODO: Add appropriate usage and instruction guidelines
## How do I contribute?
We appreciate your interest! Please see the [Dojo 2 Meta Repository](https://github.com/dojo/meta#readme) for the
Contributing Guidelines.
### Code Style
This repository uses [`prettier`](https://prettier.io/) for code styling rules and formatting. A pre-commit hook is installed automatically and configured to run `prettier` against all staged files as per the configuration in the projects `package.json`.
An additional npm script to run `prettier` (with write set to `true`) against all `src` and `test` project files is available by running:
```bash
npm run prettier
```
## Testing
Test cases MUST be written using [Intern](https://theintern.github.io) using the Object test interface and Assert assertion interface.
90% branch coverage MUST be provided for all code submitted to this repository, as reported by istanbul’s combined coverage results for all supported platforms.
To test locally in node run:
`grunt test`
To test against browsers with a local selenium server run:
`grunt test:local`
To test against BrowserStack or Sauce Labs run:
`grunt test:browserstack`
or
`grunt test:saucelabs`
## Licensing information
TODO: If third-party code was used to write this library, make a list of project names and licenses here
* [Third-party lib one](https//github.com/foo/bar) ([New BSD](http://opensource.org/licenses/BSD-3-Clause))
© [JS Foundation](https://js.foundation/) & contributors. [New BSD](http://opensource.org/licenses/BSD-3-Clause) and [Apache 2.0](https://opensource.org/licenses/Apache-2.0) licenses.