Contributing to CloudEvents' JavaScript SDK

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

We welcome contributions from the community! Please take some time to become acquainted with the process before submitting a pull request. There are just a few things to keep in mind.

Pull Requests

Typically a pull request should relate to an existing issue. If you have found a bug, want to add an improvement, or suggest an API change, please create an issue before proceeding with a pull request. For very minor changes such as typos in the documentation this isn't really necessary.

For step by step help with managing your pull request, have a look at our PR Guidelines document.

Commit Messages

Please follow the Conventional Commits specification.

Sign your work

Each PR must be signed. Be sure your git user.name and user.email are configured then use the --signoff flag for your commits.

git commit --signoff

Style Guide

Code style for this module is maintained using eslint. When you run tests with npm test linting is performed first. If you want to check your code style for linting errors without running tests, you can just run npm run lint. If there are errors, you can usually fix them automatically by running npm run fix.

Linting rules are declared in .eslintrc.