Files
docx-js/docs/contribution-guidelines.md

36 lines
713 B
Markdown
Raw Normal View History

2018-08-04 03:28:27 +01:00
# Contribution Guidelines
## Writing Code
* Include documentation reference(s) at the top of each file:
2018-08-04 04:03:08 +01:00
```js
2018-08-04 03:28:27 +01:00
// http://officeopenxml.com/WPdocument.php
```
* Follow Prettier standards, and consider using the [Prettier VSCode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) plugin.
* Follow the `TSLint` rules
## Testing
Please write a test of every file you make and suffix it with `.spec.ts`.
Here is a template of a test:
2018-08-04 04:03:08 +01:00
```js
2018-08-04 03:28:27 +01:00
import { assert } from "chai";
describe("ClassName", () => {
beforeEach(() => {
// TODO
});
describe("#methodName()", () => {
it("should ", () => {
// TODO
});
});
});
```