smartyellow/docx-js
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update contribution-guidelines.md

Browse Source
This commit is contained in:
Dolan
2019-03-05 13:32:09 +00:00
committed by GitHub
parent 2f8f69b0c4
commit 6eed0fe0f5
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/contribution-guidelines.md
View File

@ -59,6 +59,10 @@ This is so that:
public float(tableFloatProperties: TableFloatProperties): Table public float(tableFloatProperties: TableFloatProperties): Table
``` ```
```ts
table.float(new TableFloatProperties(...));
```
**Do** **Do**
`ITableFloatOptions` is an interface for a JSON of primatives. The end user would need to pass in a json object and not need to worry about the internals: `ITableFloatOptions` is an interface for a JSON of primatives. The end user would need to pass in a json object and not need to worry about the internals:
@ -67,6 +71,10 @@ This is so that:
public float(tableFloatOptions: ITableFloatOptions): Table public float(tableFloatOptions: ITableFloatOptions): Table
``` ```
```ts
table.float({...});
```
## Add vs Create ## Add vs Create
This is just a guideline, and the rules can sometimes be broken. This is just a guideline, and the rules can sometimes be broken.
@ -159,7 +167,7 @@ enum WeaponType = {
} }
``` ```
## Spell correctly, full and in American English ## Spell correctly, in full and in American English
I am not sure where these habits in software development come from, but I do not believe it is beneficial: I am not sure where these habits in software development come from, but I do not believe it is beneficial: