Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

41 lines (30 loc) · 1.74 KB
Raw

Contributing

All contributions are welcome. Please create an issue in order open up communication with the community.

Limitations

Be considerate of the Lambda@Edge limitations. The zipped function can be no more than 1MB in size and execution cannot take longer than 5 seconds, so we must pay close attention to the size of our dependencies and complexity of operations.

Commit Message Guidelines

This project follows the Conventional Commits specification to aid in automated releases and change log generation. Commitlint is enabled and ran as a commit-msg git hook to enforce the commit format. Commitizen can be used to prompt through any requirements at commit time npm run cm (or git cz if Commitizen is installed globally).

In short, if a commit will be fixing a bug, prefix the commit message with fix:

fix: my bug fix

If a commit will be adding a feature, prefix the commit message with feat:

feat: my new feature

Commits with fix: prefix will show up in the generated changelog as bullets under the Bug Fixes: section, and feat: prefixed messages will show under the Features: section. For more on the available prefixes/rules, see here.