docs: Updated project documentation

.npmignore

@@ -547,3 +547,5 @@ tsconfig.eslint.json
 .gitignore
 src/
 .npmignore
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+me@zigastrgar.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+## Setup
+
+```shell
+npm install
+```
+
+Depending on the editor, please modify the `.gitignore` to prevent additional files being added to the project.
+
+## Available scripts
+
+```shell
+# Lint
+npm run lint
+npm run lint:dev
+
+# Test
+npm run test
+
+# Build
+npm run build
+```
+
+### Testing
+
+Test will **fail** for anything under 90% coverage.
+
+## Commit messages
+
+Commit messages can have any form as long as the PR title follows the
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). There's also a CI check for that in place.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Žiga Strgar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -8,6 +8,28 @@
 Easily send your application errors to [Bugsnag](https://bugsnag.com) from your [Fastify](https://www.fastify.io/)
 server.
 
+## Description
+
+The plugin will decorate `FastifyInstance` and `FastifyRequest` with `bugsnag` property. The value behind `bugsnag`, is
+a full BugsnagClient. [Bugsnag documentation](https://docs.bugsnag.com/platforms/javascript/).
+
+To the `FastifyInstance` is attached also an `onError` handler, which will send all the errors directly to your Bugsnag
+dashboard. In the similar fashion as it's done by the official `@bugsnag/plugin-express`.
+
+⚠️ Plugin Behaviour ⚠️
+
+Be aware that the plugin mimics the behaviour of
+official [Bugsnag Express](https://github.com/bugsnag/bugsnag-js/tree/next/packages/plugin-express) plugin with
+appending
+the request data to the error. That includes `body`, `query` and `params` which may include user data!
+
+## Compatibility
+
+|         | Version   |
+|---------|-----------|
+| fastify | `>=3.x`   |
+| Bugsnag | `^7.16.5` |
+
 ## Installation
 
 ```shell
@@ -21,13 +43,30 @@ yarn add fastify-bugsnag
 ## Usage
 
 ```javascript
+// Javascript
+// index.js
 const fastify = require('fastify')();
 
 fastify.register(require('fastify-bugsnag'), {
   apiKey: 'Your-Bugsnag-API-Key', // Defaults to process.env.BUGSNAG_API_KEY
   enableReporting: process.env.NODE_ENV === 'production', // OR similar
+  // Rest of Bugsnag Configuration Options
 });
 
+// Typescript/ESM
+// index.ts
+import fastify from 'fastify';
+import fastifyBugsnag from 'fastify-bugsnag';
+
+fastify.register(fastifyBugsnag, {
+  apiKey: 'Your-Bugsnag-API-Key', // Defaults to process.env.BUGSNAG_API_KEY
+  enableReporting: process.env.NODE_ENV === 'production', // OR similar
+  // Rest of Bugsnag Configuration Options
+});
+```
+
+```javascript
+// routes.ts
 fastify.get('/', async (request, reply) => {
   fastify.bugsnag.leaveBreadcrumb('Visited homepage'); // OR request.bugsnag.leaveBreadcrumb();
 });
@@ -37,24 +76,16 @@ fastify.get('/error', async (request, reply) => {
 });
 ```
 
-## Description
-
-The plugin will decorate fastify instance with `bugsnag` property and `request` as well. The value behind `bugsnag`, is
-a full BugsnagClient. [Bugsnag documentation](https://docs.bugsnag.com/platforms/javascript/)
-
-Be aware that the plugin mimics the behaviour of
-official [Bugsnag Express](https://github.com/bugsnag/bugsnag-js/tree/next/packages/plugin-express) plugin with appending
-the request data to the error. That includes `body`, `query` and `params` which may include user data!
-
 ## Options
 
 | Parameter         | Default Value                 | Description                                                                                 |
 |-------------------|-------------------------------|---------------------------------------------------------------------------------------------|
 | `apiKey`          | `process.env.BUGSNAG_API_KEY` | API Key obtained from Bugsnag dashboard project. **REQUIRED**                               |
 | `enableReporting` | `undefined`                   | Set to `true` on environments or under conditions you want to report the errors to Bugsnag. |
 
-For additional options check [here](https://docs.bugsnag.com/platforms/javascript/configuration-options/).
+For additional options check the official documentation of Bugsnag
+[here](https://docs.bugsnag.com/platforms/javascript/configuration-options/).
 
 ## License
 
-Licensed under MIT.
+Licensed under [MIT](./LICENSE).

SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+|---------|--------------------|
+| 0.4.x   | :white_check_mark: |
+| 0.3.x   | :white_check_mark: |
+| < 0.3.x | :x:                |
+
+## Reporting a Vulnerability
+
+To report a security vulnerability please email me at [me@zigastrgar.com](mailto:me@zigastrgar.com).