chore: devcontainer (#203)

Author: abernier

.devcontainer/devcontainer.json

@@ -0,0 +1,28 @@
+{
+  "image": "mcr.microsoft.com/vscode/devcontainers/javascript-node:18",
+  "hostRequirements": {
+    "memory": "8gb"
+  },
+  "waitFor": "onCreateCommand",
+  "updateContentCommand": "yarn install",
+  "postCreateCommand": "",
+  "postAttachCommand": "yarn storybook",
+  "customizations": {
+    "codespaces": {
+      "openFiles": ["CONTRIBUTING.md"]
+    },
+    "vscode": {
+      "settings": {
+        "editor.formatOnSave": true
+      },
+      "extensions": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
+    }
+  },
+  "portsAttributes": {
+    "6006": {
+      "label": "Storybook server",
+      "onAutoForward": "openPreview"
+    }
+  },
+  "forwardPorts": [6006]
+}

CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+Thanks for wanting to make a contribution and wanting to improve this library for everyone! This repository uses Typescript so please continue to do so, you can always reach out in the repo or the [discord](https://pmnd.rs/discord). This is a guideline, use your initiative, if you don't think it makes sense to do a step in here, don't bother it's normally okay. we're chill.
+
+## How to Contribute
+
+1.  Fork and clone the repo
+2.  Run `yarn install` to install dependencies
+3.  Create a branch for your PR with `git checkout -b pr-type/issue-number-your-branch-name`
+4.  Let's get cooking! 👨🏻‍🍳🥓
+
+You can also just [![Open in GitHub Codespaces](https://img.shields.io/static/v1?&message=Open%20in%20%20Codespaces&style=flat&colorA=000000&colorB=000000&label=GitHub&logo=github&logoColor=ffffff)](https://github.com/codespaces/new?template_repository=pmndrs%2Freact-postprocessing).
+
+## Commit Guidelines
+
+Be sure your commit messages follow this specification: https://www.conventionalcommits.org/en/v1.0.0-beta.4/
+
+## Storybook
+
+If you're adding a brand new feature, you need to make sure you add a storybook entry, here's a few tips:
+
+- Keep the story simple & show the essence of the component, remember some people may be looking at using drei for the first time & it's important the stories are clear and concise.
+- Keep assets minimal (3D Models, textures) to avoid bloating the repository
+- If you think a more involved example is necessary, you can always add a codesandbox to the main README while keeping the story minimalistic
+
+## Publishing
+
+We use `semantic-release` to deploy the package. Because of this only certain commits will trigger the action of creating a release:
+
+- `fix:` will create a `0.0.x` version
+- `feat:` will create a `0.x.0` version
+- `BREAKING CHANGE:` will create a `x.0.0` version
+
+We release on `master` branch. Any other commits will not fire a release.

README.md

@@ -4,6 +4,7 @@
 [![Storybook](https://img.shields.io/static/v1?message=Storybook&style=flat&colorA=000000&colorB=000000&label=&logo=storybook&logoColor=ffffff)](https://pmndrs.github.io/react-postprocessing)
 [![Downloads](https://img.shields.io/npm/dt/@react-three/postprocessing.svg?style=flat&colorA=000000&colorB=000000)](https://www.npmjs.com/package/@react-three/postprocessing)
 [![Discord Shield](https://img.shields.io/discord/740090768164651008?style=flat&colorA=000000&colorB=000000&label=discord&logo=discord&logoColor=ffffff)](https://discord.gg/ZZjjNvJ)
+[![Open in GitHub Codespaces](https://img.shields.io/static/v1?&message=Open%20in%20%20Codespaces&style=flat&colorA=000000&colorB=000000&label=GitHub&logo=github&logoColor=ffffff)](https://github.com/codespaces/new?template_repository=pmndrs%2Freact-postprocessing)
 
 `react-postprocessing` is a
 [postprocessing](https://github.com/pmndrs/postprocessing) wrapper for