docs(): update contributing.md

.commitlintrc.json

@@ -9,20 +9,7 @@
     "type-enum": [
       2,
       "always",
-      [
-        "build",
-        "chore",
-        "ci",
-        "docs",
-        "feat",
-        "fix",
-        "perf",
-        "refactor",
-        "revert",
-        "style",
-        "test",
-        "sample"
-      ]
+      ["build", "chore", "ci", "docs", "feat", "fix", "perf", "refactor", "style", "test"]
     ]
   }
 }

.prettierrc

@@ -1,4 +1,5 @@
 {
   "singleQuote": true,
-  "trailingComma": "all"
+  "trailingComma": "all",
+  "printWidth": 100
 }

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to Nest
 
-We would love for you to contribute to NestJS Notification and help make it even better than it is
+We would love for you to contribute to NestJS notification and help make it even better than it is
 today! As a contributor, here are the guidelines we would like you to follow:
 
 - [Code of Conduct](#coc)
@@ -10,3 +10,221 @@ today! As a contributor, here are the guidelines we would like you to follow:
 - [Submission Guidelines](#submit)
 - [Coding Rules](#rules)
 - [Commit Message Guidelines](#commit)
+
+## <a name="coc"></a> Code of Conduct
+
+Help us keep Nest open and inclusive. Please read and follow our [Code of Conduct][coc].
+
+## <a name="question"></a> Got a Question or Problem?
+
+**Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests.** You've got much better chances of getting your question answered on [Stack Overflow][stackoverflow] where the questions should be tagged with tag `nestjs-notification`.
+
+Stack Overflow is a much better place to ask questions since:
+
+- questions and answers stay available for public viewing, so your question / answer might help someone else
+- Stack Overflow's voting system assures that the best answers are prominently visible.
+
+To save your and our time, we will systematically close all issues that are requests for general support and redirect people to Stack Overflow.
+
+## <a name="issue"></a> Found a Bug?
+
+If you find a bug in the source code, you can help us by
+[submitting an issue](#submit-issue) to our [GitHub Repository][github]. Even better, you can
+[submit a Pull Request](#submit-pr) with a fix.
+
+## <a name="feature"></a> Missing a Feature?
+
+You can _request_ a new feature by [submitting an issue](#submit-issue) to our GitHub
+Repository. If you would like to _implement_ a new feature, please submit an issue with
+a proposal for your work first, to be sure that we can use it.
+Please consider what kind of change it is:
+
+- For a **Major Feature**, first open an issue and outline your proposal so that it can be
+  discussed. This will also allow us to better coordinate our efforts, prevent duplication of work,
+  and help you to craft the change so that it is successfully accepted into the project. For your issue name, please prefix your proposal with `[discussion]`, for example "[discussion]: your feature idea".
+- **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
+
+## <a name="submit"></a> Submission Guidelines
+
+### <a name="submit-issue"></a> Submitting an Issue
+
+Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
+
+We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we will systematically ask you to provide a minimal reproduction scenario using a repository or [Gist](https://gist.github.com/). Having a live, reproducible scenario gives us wealth of important information without going back & forth to you with additional questions like:
+
+- version of NestJS notification used
+- 3rd-party libraries and their versions
+- and most importantly - a use-case that fails
+
+Unfortunately, we are not able to investigate / fix bugs without a minimal reproduction, so if we don't hear back from you, we are going to close an issue that don't have enough info to be reproduced.
+
+You can file new issues by filling out our [new issue form](https://github.com/sinuoslabs/nestjs-notification/issues/new).
+
+### <a name="submit-pr"></a> Submitting a Pull Request (PR)
+
+Before you submit your Pull Request (PR) consider the following guidelines:
+
+1. Search [GitHub](https://github.com/sinuoslabs/nestjs-notification/pulls) for an open or closed PR
+   that relates to your submission. You don't want to duplicate effort.
+1. Fork the sinuoslabs/nestjs-notification repo.
+1. Make your changes in a new git branch:
+
+   ```shell
+   git checkout -b my-fix-branch main
+   ```
+
+1. Create your patch, **including appropriate test cases**.
+1. Follow our [Coding Rules](#rules).
+1. Commit your changes using a descriptive commit message that follows our
+   [commit message conventions](#commit). Adherence to these conventions
+   is necessary because release notes are automatically generated from these messages.
+
+   ```shell
+   git commit -a
+   ```
+
+   Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
+
+1. Push your branch to GitHub:
+
+   ```shell
+   git push origin my-fix-branch
+   ```
+
+1. In GitHub, send a pull request to `nestjs-notification:main`.
+
+- If we suggest changes then:
+
+  - Make the required updates.
+  - Re-run the Nest test suites to ensure tests are still passing.
+  - Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
+
+    ```shell
+    git rebase main -i
+    git push -f
+    ```
+
+That's it! Thank you for your contribution!
+
+#### After your pull request is merged
+
+After your pull request is merged, you can safely delete your branch and pull the changes
+from the main (upstream) repository:
+
+- Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
+
+  ```shell
+  git push origin --delete my-fix-branch
+  ```
+
+- Check out the main branch:
+
+  ```shell
+  git checkout main -f
+  ```
+
+- Delete the local branch:
+
+  ```shell
+  git branch -D my-fix-branch
+  ```
+
+- Update your main with the latest upstream version:
+
+  ```shell
+  git pull --ff upstream main
+  ```
+
+## <a name="rules"></a> Coding Rules
+
+To ensure consistency throughout the source code, keep these rules in mind as you are working:
+
+- All features or bug fixes **must be tested** by one or more specs (unit-tests).
+- We follow [Google's JavaScript Style Guide][js-style-guide], but wrap all code at
+  **100 characters**. An automated formatter is available.
+
+## <a name="commit"></a> Commit Message Guidelines
+
+We have very precise rules over how our git commit messages can be formatted. This leads to **more
+readable messages** that are easy to follow when looking through the **project history**. But also,
+we use the git commit messages to **generate the Nest change log**.
+
+### Commit Message Format
+
+Each commit message consists of a **header**, a **body** and a **footer**. The header has a special
+format that includes a **type**, a **scope**, and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory, and the **scope** of the header is optional.
+
+Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
+to read on GitHub as well as in various git tools.
+
+Footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
+
+Samples: (even more [samples](https://github.com/sinuoslabs/nestjs-notification/commits/main))
+
+```
+docs(changelog) update change log to beta.5
+```
+
+```
+fix(@nestjs/common) need to depend on latest rxjs and zone.js
+The version in our package.json gets copied to the one we publish, and users need the latest of these.
+```
+
+### Revert
+
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+
+Must be one of the following:
+
+- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+- **chore**: Updating tasks etc; no production code change
+- **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+- **docs**: Documentation only changes
+- **feat**: A new feature
+- **fix**: A bug fix
+- **perf**: A code change that improves performance
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+- **test**: Adding missing tests or correcting existing tests
+
+### Subject
+
+The subject contains succinct description of the change:
+
+- use the imperative, present tense: "change" not "changed" nor "changes"
+- don't capitalize first letter
+- no dot (.) at the end
+
+### Body
+
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+
+The footer should contain any information about **Breaking Changes** and is also the place to
+reference GitHub issues that this commit **Closes**.
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
+
+A detailed explanation can be found in this [document][commit-message-format].
+
+[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
+[corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html
+[coc]: https://github.com/sinuoslabs/nestjs-notification/blob/main/CODE_OF_CONDUCT.md
+[github]: https://github.com/sinuoslabs/nestjs-notification
+[individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html
+[js-style-guide]: https://google.github.io/styleguide/jsguide.html
+[stackoverflow]: http://stackoverflow.com/questions/tagged/nestjs-notification

lib/interfaces/nestjs-notify-module.interface.ts

@@ -5,9 +5,7 @@ import { ModuleMetadata, Provider, Type } from '@nestjs/common';
  * @property createNestjsNotifyOptions()
  */
 export interface NestjsNotifyModuleOptionsFactory {
-  createNestjsNotifyOptions():
-    | Promise<NestjsNotifyModuleOptions>
-    | NestjsNotifyModuleOptions;
+  createNestjsNotifyOptions(): Promise<NestjsNotifyModuleOptions> | NestjsNotifyModuleOptions;
 }
 
 /**
@@ -19,19 +17,17 @@ export interface NestjsNotifyModuleOptionsFactory {
  * @property inject
  * @property extraProviders
  */
-export interface NestjsNotifyModuleAsyncOptions
-  extends Pick<ModuleMetadata, 'imports'> {
+export interface NestjsNotifyModuleAsyncOptions extends Pick<ModuleMetadata, 'imports'> {
   useExisting?: Type<NestjsNotifyModuleOptionsFactory>;
   useClass?: Type<NestjsNotifyModuleOptionsFactory>;
-  useFactory?: (
-    ...args: any[]
-  ) => Promise<NestjsNotifyModuleOptions> | NestjsNotifyModuleOptions;
+  useFactory?: (...args: any[]) => Promise<NestjsNotifyModuleOptions> | NestjsNotifyModuleOptions;
   inject?: any[];
   extraProviders?: Provider[];
 }
 
 /**
  * @interface NestjsNotifyModuleOptions
+ * @property queue
  */
 export interface NestjsNotifyModuleOptions {
   queue?: any;

lib/interfaces/nestjs-notify.interface.ts

@@ -3,6 +3,8 @@ import { INestjsNotifyChannel } from './nestjs-notify-channel.interface';
 
 /**
  * @interface NestJsNotify
+ * @property sendToChannels()
+ * @property toPayload?()
  */
 export interface NestJsNotify {
   /**
@@ -13,7 +15,7 @@ export interface NestJsNotify {
 
   /**
    * Get the json representation of the notification.
-   * @returns json
+   * @returns {Record<string, any>}
    */
   toPayload?(): Record<string, any>;
 }

package.json

@@ -31,7 +31,6 @@
     "index.d.ts"
   ],
   "peerDependencies": {
-    "@nestjs/axios": "0.0.3",
     "@nestjs/common": "^7.0.0 || ^8.0.0",
     "reflect-metadata": "^0.1.12",
     "rxjs": "^6.0.0 || ^7.0.0"
@@ -40,7 +39,6 @@
   "devDependencies": {
     "@commitlint/cli": "15.0.0",
     "@commitlint/config-angular": "15.0.0",
-    "@nestjs/axios": "0.0.3",
     "@nestjs/common": "8.2.3",
     "@nestjs/core": "8.2.3",
     "@nestjs/platform-express": "8.2.3",