Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

60 lines (47 loc) · 2.01 KB
Raw

How to contribute

Contributions to the project generally take one of three forms:

  1. Issues reports
    1. Bug reports
    2. Feature requests
  2. Patches
  3. Documentation/examples improvements

Issues reports

The proper way to report Bug/Feature is to use corresponding issue template.

The maintenance team will read all created issues and …:

  1. … provide additional information such as priority and/or ask for more information
  2. … assign them to targerted milestone (with specific deadline, if it is known).

Patches

We're super grateful for your patch

The best way to make sure your issue is addressed is to submit a patch. We accept patches through all mediums: pull requests, issue comment, email (andrle.jan+at+centrum.cz) and mastodon (@[email protected]).

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

  • make your commit message describtive and use issue links for better understandig commit purpose.
  • make your coding style similar to ours, mainly
    • use tabulator for indentation
    • camelCase for function names
    • snake_case for variables

Development Environment

The library is developed using Node.js and has a number of dependencies specified in its package.json file. To install them just run the following command from within your repo directory:

$ npm ci

There is npm task for generating documentation from TypeScript anotations:

npm run build

Documentation/examples improvements

You can use issue for reporting errors and suggesting improvements similary to Issues reports. It is also acceptable to open issue with question if it wasn’t currently adressed anywhere and you think it schould.

For updating documentation and examples follow Patches. The documentation is created by typedoc.

You can also improve examples founded in examples/.

This text was inspired by jshint’s one.