Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 1023 Bytes

CONTRIBUTING.md

File metadata and controls

58 lines (41 loc) · 1023 Bytes

Contributing

License

MIT.

Versioning

Semantic Versioning.

Development

Available commands to ease development, packaging and installing:

$ make install
$ make build
$ make lint
$ make unit
$ make test
$ make package

Coding style

To verify that your additions follows coding style, run:

$ make lint

Unit tests

To run test suite:

$ make unit

Configure git

For convenience your committer, git user, should be linked to your GitHub account:

$ git config --global user.name "John Doe"
$ git config --global user.email [email protected]

Make sure to use an email address that is linked to your GitHub account. It can be a throwaway address or you can use GitHub's email protection features. We don't want your emails, but this is to make sure we know who did what. All commits nicely link to their author, instead of them coming from [email protected].