Skip to content

Commit d5b79f9

Browse files
committed
modified: CONTRIBUTING.md
1 parent 7a28e8b commit d5b79f9

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,24 @@ The proper way to report Bug/Feature is to use corresponding issue template.
1212

1313
The maintenance team will read all created issues and …:
1414

15-
<!--1. … assign them to proper [projects](../../projects/)
16-
based on targerted library version. Also, each issue schould have chooosed
17-
priority (__low__/__high__) by using specific column i project
18-
(__To Do – Low priority__/__To Do – High priority__).-->
15+
1. … provide additional information such as priority and/or ask for more information
1916
1. … assign them to targerted milestone (with specific deadline, if it is known).
2017

2118
## Patches
2219
__We're super grateful for your patch__
2320

2421
The best way to make sure your issue is addressed is to submit a patch.
25-
We accept patches through all mediums: pull requests, email, issue
26-
comment, tweet with a link to a snippet, etc.
22+
We accept patches through all mediums: pull requests, issue
23+
comment, email (andrle.jan+at+centrum.cz) and mastodon (@jaandrle@fosstodon.org).
2724

2825
However, before sending a patch, please take try to:
2926

3027
- make your commit message describtive and use issue links for better
3128
understandig commit purpose.
32-
- make your coding style similar to ours (TBD).
29+
- make your coding style similar to ours, mainly
30+
- use tabulator for indentation
31+
- camelCase for function names
32+
- snake\_case for variables
3333

3434
### Development Environment
3535
The library is developed using [Node.js](http://nodejs.org/) and has
@@ -39,6 +39,10 @@ repo directory:
3939
```bash
4040
$ npm ci
4141
```
42+
There is `npm` task for generating documentation from TypeScript anotations:
43+
```bash
44+
npm run doc
45+
```
4246

4347
## Documentation/examples improvements
4448
You can use issue for reporting errors and suggesting improvements
@@ -48,7 +52,8 @@ and you think it schould.
4852

4953
For updating documentation and examples follow [Patches](#Patches).
5054
The documentation is created by [typedoc](https://github.com/TypeStrong/typedoc).
51-
Examples are in [examples/](./docs/examples/).
55+
56+
You can also improve examples founded in [examples/](./docs/examples/).
5257

5358
---
5459
This text was inspired by

0 commit comments

Comments
 (0)