Merge pull request #147 from golevelup/docs/contributions

docs(all packages): contributing and license links
golevelup · May 12, 2020 · 75c72a7 · 75c72a7
2 parents 0005d45 + 5f28cb0
commit 75c72a7
Show file tree

Hide file tree

Showing 10 changed files with 110 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -25,3 +25,11 @@ A collection of Badass modules and utilities to help you level up your NestJS ap
 | [`@golevelup/nestjs-graphql-request`](./packages/graphql-request) | Dependency Injection for GraphQLClient. Make type safe requests to third party GQL APIs                                  | [![version](https://img.shields.io/npm/v/@golevelup/nestjs-graphql-request.svg)](https://www.npmjs.com/package/@golevelup/nestjs-graphql-request) | [changelog](./packages/graphql-request/CHANGELOG.md) |
 | [`@golevelup/nestjs-webhooks`](./packages/webhooks)               | Middlewares and helpers for processing webhooks                                                                          | [![version](https://img.shields.io/npm/v/@golevelup/nestjs-webhooks.svg)](https://www.npmjs.com/package/@golevelup/nestjs-webhooks)               | [changelog](./packages/webhooks/CHANGELOG.md)        |
 | [`@golevelup/nestjs-stripe`](./packages/stripe)                   | Stripe client and webhook processing                                                                                     | [![version](https://img.shields.io/npm/v/@golevelup/nestjs-stripe.svg)](https://www.npmjs.com/package/@golevelup/nestjs-stripe)                   | [changelog](./packages/stripe/CHANGELOG.md)          |
+
+## Contribute
+
+Contributions welcome! Read the [contribution guidelines](CONTRIBUTING.md) first.
+
+## License
+
+[MIT License](LICENSE)
diff --git a/packages/common/README.md b/packages/common/README.md
@@ -18,3 +18,11 @@ to consume
 ## Mixins
 
 The mixin pattern is particularly useful with NestJS components like `Interceptors` as a mechanism to provide both configuration while still allowing the component to participate with Nest's `Dependency Injection`.
+
+## Contribute
+
+Contributions welcome! Read the [contribution guidelines](../../CONTRIBUTING.md) first.
+
+## License
+
+[MIT License](../../LICENSE)
diff --git a/packages/discovery/README.md b/packages/discovery/README.md
@@ -35,7 +35,7 @@ import { DiscoveryModule } from '@golevelup/nestjs-discovery';
 import { Module } from '@nestjs/common';
 
 @Module({
-  imports: [DiscoveryModule]
+  imports: [DiscoveryModule],
 })
 export class ExampleModule implements OnModuleInit {
   constructor(private readonly discover: DiscoveryService) {}
@@ -114,3 +114,11 @@ const exampleMethodsMeta = await this.discover.controllerMethodsWithMetaAtKey<
   string
 >('exampleKey');
 ```
+
+## Contribute
+
+Contributions welcome! Read the [contribution guidelines](../../CONTRIBUTING.md) first.
+
+## License
+
+[MIT License](../../LICENSE)
diff --git a/packages/graphql-request/README.md b/packages/graphql-request/README.md
@@ -99,3 +99,11 @@ export class AppModule {
   // ...
 }
 ```
+
+## Contribute
+
+Contributions welcome! Read the [contribution guidelines](../../CONTRIBUTING.md) first.
+
+## License
+
+[MIT License](../../LICENSE)
diff --git a/packages/hasura/README.md b/packages/hasura/README.md
@@ -93,3 +93,11 @@ The `HasuraModule` makes it easy to reuse the same events API endpoint for all e
 #### Important!
 
 when creating the event in Hasura, ensure that the Header Name and Value match the configuration provided to the `HasuraModule` configuration in your NestJS application. This ensures that only Hasura can trigger events in your system.
+
+## Contribute
+
+Contributions welcome! Read the [contribution guidelines](../../CONTRIBUTING.md) first.
+
+## License
+
+[MIT License](../../LICENSE)
diff --git a/packages/modules/README.md b/packages/modules/README.md
@@ -51,7 +51,7 @@ import { ConfigModule } from './config.service'; // the service to be provided t
 
 @Module({
   providers: [ConfigService],
-  exports: [ConfigService]
+  exports: [ConfigService],
 })
 export class ConfigModule extends createConfigurableDynamicRootModule<
   ConfigModule,
@@ -63,7 +63,7 @@ And just like that, you've created a Dynamic module. Now in your root module you
 
 ```ts
 @Module({
-  imports: [ConfigModule.forRoot(ConfigModule, synchronousConfigModuleOptions)]
+  imports: [ConfigModule.forRoot(ConfigModule, synchronousConfigModuleOptions)],
 })
 export class AppModule {}
 ```
@@ -72,7 +72,7 @@ or asynchronously
 
 ```ts
 @Module({
-  imports: [ConfigModule.forRootAsync(ConfigModule, asyncConfigModuleOptions)]
+  imports: [ConfigModule.forRootAsync(ConfigModule, asyncConfigModuleOptions)],
 })
 export class AppModule {}
 ```
@@ -85,7 +85,7 @@ For re-using the configured dynamic modules, the module provides a static method
 
 ```ts
 @Module({
-  imports: [ConfigModule.externallyConfigured(ConfigModule, 0)]
+  imports: [ConfigModule.externallyConfigured(ConfigModule, 0)],
 })
 export class ConfigModuleDependentModule {}
 ```
@@ -103,7 +103,7 @@ import { ConfigModule } from './config.service'; // the service to be provided t
 
 @Module({
   providers: [ConfigService],
-  exports: [ConfigService]
+  exports: [ConfigService],
 })
 export class ConfigModule extends createConfigurableDynamicRootModule<
   ConfigModule,
@@ -117,7 +117,15 @@ Now it can be used in another module like this:
 
 ```ts
 @Module({
-  imports: [ConfigModule.Deferred]
+  imports: [ConfigModule.Deferred],
 })
 export class ConfigModuleDependentModule {}
 ```
+
+## Contribute
+
+Contributions welcome! Read the [contribution guidelines](../../CONTRIBUTING.md) first.
+
+## License
+
+[MIT License](../../LICENSE)
diff --git a/packages/rabbitmq/README.md b/packages/rabbitmq/README.md
@@ -8,26 +8,29 @@
 
 # Table of Contents
 
-- [Description](#description)
-- [Motivation](#motivation)
-- [Connection Management](#connection-management)
-- [Usage](#usage)
-  - [Install](#install)
-  - [Module Initialization](#module-initialization)
-- [Receiving Messages](#receiving-messages)
-  - [Exposing RPC Handlers](#exposing-rpc-handlers)
-  - [Exposing Pub/Sub Handlers](#exposing-pubsub-handlers)
-  - [Message Handling](#message-handling)
-  - [Conditional Handler Registration](#conditional-handler-registration)
-- [Sending Messages](#sending-messages)
-  - [Inject the AmqpConnection](#inject-the-amqpconnection)
-  - [Publising Messages (Fire and Forget)](#publising-messages-fire-and-forget)
-  - [Requesting Data from an RPC](#requesting-data-from-an-rpc)
-    - [Type Inference](#type-inference)
-    - [Interop with other RPC Servers](#interop-with-other-rpc-servers)
-- [Advanced Patterns](#advanced-patterns)
-  - [Competing Consumers](#competing-consumers)
-- [TODO](#todo)
+- [@golevelup/nestjs-rabbitmq](#golevelupnestjs-rabbitmq)
+- [Table of Contents](#table-of-contents)
+  - [Description](#description)
+  - [Motivation](#motivation)
+  - [Connection Management](#connection-management)
+  - [Usage](#usage)
+    - [Install](#install)
+    - [Module Initialization](#module-initialization)
+  - [Receiving Messages](#receiving-messages)
+    - [Exposing RPC Handlers](#exposing-rpc-handlers)
+    - [Exposing Pub/Sub Handlers](#exposing-pubsub-handlers)
+    - [Message Handling](#message-handling)
+    - [Conditional Handler Registration](#conditional-handler-registration)
+  - [Sending Messages](#sending-messages)
+    - [Inject the AmqpConnection](#inject-the-amqpconnection)
+    - [Publising Messages (Fire and Forget)](#publising-messages-fire-and-forget)
+    - [Requesting Data from an RPC](#requesting-data-from-an-rpc)
+      - [Type Inference](#type-inference)
+      - [Interop with other RPC Servers](#interop-with-other-rpc-servers)
+  - [Advanced Patterns](#advanced-patterns)
+    - [Competing Consumers](#competing-consumers)
+  - [Contribute](#contribute)
+  - [License](#license)
 
 ## Description
 
@@ -296,3 +299,11 @@ export class MessagingService {
   }
 }
 ```
+
+## Contribute
+
+Contributions welcome! Read the [contribution guidelines](../../CONTRIBUTING.md) first.
+
+## License
+
+[MIT License](../../LICENSE)
diff --git a/packages/stripe/README.md b/packages/stripe/README.md
@@ -124,3 +124,11 @@ class PaymentCreatedService {
 ### Configure Webhooks in the Stripe Dashboard
 
 Follow the instructions from the [Stripe Documentation](https://stripe.com/docs/webhooks) for remaining integration steps such as testing your integration with the CLI before you go live and properly configuring the endpoint from the Stripe dashboard so that the correct events are sent to your NestJS app.
+
+## Contribute
+
+Contributions welcome! Read the [contribution guidelines](../../CONTRIBUTING.md) first.
+
+## License
+
+[MIT License](../../LICENSE)
diff --git a/packages/testing/README.md b/packages/testing/README.md
@@ -114,3 +114,11 @@ describe('Mocked Execution Context', () => {
 The above case shows how well the `createMock` utility can take in user provided values as well as returning **type safe** mocks that can easily be chained and modified as needed.
 
 For a few more examples on what can be done [the mock.spec](src/mocks.spec.ts) file has some really cool examples that show pretty well just what is doable with this utility.
+
+## Contribute
+
+Contributions welcome! Read the [contribution guidelines](../../CONTRIBUTING.md) first.
+
+## License
+
+[MIT License](../../LICENSE)
diff --git a/packages/webhooks/README.md b/packages/webhooks/README.md
@@ -77,3 +77,11 @@ class AppModule implements NestModule {
   }
 }
 ```
+
+## Contribute
+
+Contributions welcome! Read the [contribution guidelines](../../CONTRIBUTING.md) first.
+
+## License
+
+[MIT License](../../LICENSE)