@benningfield-group/bgi-mailer

A npm package for sending emails via SendGrid.

Usage no npm install needed!

<script type="module">
  import benningfieldGroupBgiMailer from 'https://cdn.skypack.dev/@benningfield-group/bgi-mailer';
</script>

README

README

What is this repository for?

A npm package for sending emails via SendGrid.

How do I make changes to the package?

Use git to clone the respository to a local machine.
Follow the Gitflow Workflow to make changes.
https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow
Run npm login to login to an npm account.
Run npm publish to push the newest version to the npm registry.

Running Tests

The command npm test runs the jasmine test suite once.
The commmand npm run test:watch runs the jasmine test suite in watch mode.
While in watch mode, the tests rerun if an update to the code is detected.

Contribution guidelines

Please write tests for new services before writing the service.
All tests must pass before changes are merged into develop or master.
All changes must be code reviewed by another developer.
All changes must go through quality assurance.
Release candidates must go through user acceptance testing.