Add more documentation
This commit is contained in:
35
docs/contribution-guidelines.md
Normal file
35
docs/contribution-guidelines.md
Normal file
@ -0,0 +1,35 @@
|
||||
# Contribution Guidelines
|
||||
|
||||
## Writing Code
|
||||
|
||||
* Include documentation reference(s) at the top of each file:
|
||||
|
||||
```ts
|
||||
// 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:
|
||||
|
||||
```ts
|
||||
import { assert } from "chai";
|
||||
|
||||
describe("ClassName", () => {
|
||||
beforeEach(() => {
|
||||
// TODO
|
||||
});
|
||||
|
||||
describe("#methodName()", () => {
|
||||
it("should ", () => {
|
||||
// TODO
|
||||
});
|
||||
});
|
||||
});
|
||||
```
|
Reference in New Issue
Block a user