fix: adding contributing guidelines (#42)

Author: paulmarsicloud

CONTRIBUTING.MD

@@ -0,0 +1,110 @@
+Thank you for contributing!
+
+## Development
+
+### Installing dependencies
+
+```sh
+yarn install
+```
+
+### Testing
+
+You will find tests for files colocated with `*.test.ts` suffixes. Whenever making any changes, ensure that all existing tests pass by running `yarn test`.
+
+If you are adding a new feature or some extra functionality, you should also make sure to accompany those changes with appropriate tests.
+
+### Linting and Formatting
+
+Before committing any changes, be sure to do `yarn lint`; this will lint all relevant files using [ESLint](http://eslint.org/) and report on any changes that you need to make.
+
+### Before submitting a PR...
+
+Thanks for taking the time to help us make pino-lambda even better! Before you go ahead and submit a PR, make sure that you have done the following:
+
+- Run the tests using `yarn test`.
+- Run lint and flow using `yarn lint`
+- Ensure your branch and commit message conform to the [`semantic-release`](https://github.com/semantic-release/semantic-release#commit-message-format) format
+
+### Semantic-Release
+
+We use [`semantic-release`](https://github.com/semantic-release/semantic-release) to create package versions and publish them.
+
+Ensure your branch name and commit message format conform to the [`semantic-release`](https://github.com/semantic-release/semantic-release#commit-message-format) format before submitting your PR.
+
+When completed successfully, a `semantic-release` message will be added to your merged PR, with a link to the NPM Package and GitHub Release.
+
+## Contributor Covenant Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at emma.brillhart@formidable.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -25,9 +25,12 @@ import { lambdaRequestTracker, pinoLambdaDestination } from 'pino-lambda';
 
 // custom destination formatter
 const destination = pinoLambdaDestination();
-const logger = pino({
-  // typical pino options
-}, destination);
+const logger = pino(
+  {
+    // typical pino options
+  },
+  destination,
+);
 const withRequest = lambdaRequestTracker();
 
 async function handler(event, context) {
@@ -60,13 +63,13 @@ other Cloudwatch aware tools such as Datadog and Splunk.
 
 With context tracing enabled, all instances of `pino` that use one of the built in formatters will automatically log the request id and other details so you don't need to pass an instance of a logger to all of your functions.
 
-| Property                  | Value                                      | Info                                                                     |
-| ------------------------- | ------------------------------------------ | ------------------------------------------------------------------------ |
-| awsRequestId              | context.awsRequestId                       | The unique request id for this request                                   |
-| apiRequestId              | context.requestContext.requestId           | The API Gateway RequestId                                                |
-| x-correlation-id          | event.headers['x-correlation-id']          | The upstream request id for tracing                                      |
-| x-correlation-trace-id    | process.env._X_AMZN_TRACE_ID               | The AWS Xray tracking id                                                 |
-| x-correlation-\*          | event.headers.startsWith('x-correlation-') | Any header that starts with `x-correlation-` will be automatically added |
+| Property               | Value                                      | Info                                                                     |
+| ---------------------- | ------------------------------------------ | ------------------------------------------------------------------------ |
+| awsRequestId           | context.awsRequestId                       | The unique request id for this request                                   |
+| apiRequestId           | context.requestContext.requestId           | The API Gateway RequestId                                                |
+| x-correlation-id       | event.headers['x-correlation-id']          | The upstream request id for tracing                                      |
+| x-correlation-trace-id | process.env.\_X_AMZN_TRACE_ID              | The AWS Xray tracking id                                                 |
+| x-correlation-\*       | event.headers.startsWith('x-correlation-') | Any header that starts with `x-correlation-` will be automatically added |
 
 Every AWS Lambda request contains a unique request ID, `context.awsRequestId`. If the request originated outside of the AWS platform,
 the request ID will match the `event.header.x-correlation-id` value. However, if the request originated from within the AWS platform,
@@ -77,7 +80,7 @@ Amazon XRAY also has a unique tracing ID that is propagated across the requests
 
 ## Customize request tracing
 
-You can customize the data that is tracked for each request by adding a per-request mixin. 
+You can customize the data that is tracked for each request by adding a per-request mixin.
 The request mixin takes the Lambda `event` and `context` and returns an object.
 
 This differs from the built in [pino mixin](https://github.com/pinojs/pino/blob/master/docs/api.md#mixin-function) as it only executes
@@ -100,9 +103,9 @@ const withRequest = lambdaRequestTracker({
       'x-correlation-id': undefined,
 
       // add any type of static data
-      brand: 'famicom'
+      brand: 'famicom',
     };
-  }
+  },
 });
 
 async function handler(event, context) {
@@ -132,11 +135,7 @@ By default, the `pinoLambdaDestination` uses the `CloudwatchLogFormatter`. If yo
 
 ```ts
 import pino from 'pino';
-import { 
-  lambdaRequestTracker, 
-  pinoLambdaDestination,
-  PinoLogFormatter
-} from 'pino-lambda';
+import { lambdaRequestTracker, pinoLambdaDestination, PinoLogFormatter } from 'pino-lambda';
 
 const destination = pinoLambdaDestination({
   formatter: new PinoLogFormatter(),
@@ -226,6 +225,9 @@ async function handler(event, context) {
 
 You can use the this wrapper outside of the AWS lambda function in any place you want. This is especially useful in private npm modules that will be used by your AWS Lambda function. The default logger context is a shared instance, so it inherits all properties the default is configured for, and will emit request information for all logs. This effectively allows you to track a request across its entire set of log entries.
 
+## Contributing
+
+Please see our [contributing guide](CONTRIBUTING.md).
 
 ## Maintenance Status