Create CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,211 @@
+# Contributing
+
+Thanks for your interest in contributing to GuardianUI! Please take a moment to review this document **before submitting a pull request.** 
+
+We're big fans of [wagmi](https://github.com/wagmi-dev/wagmi), so if you're familiar with their contributing guidelines then you'll recognize many of the same concepts here.  
+
+If you want to contribute, but aren't sure where to start, you can create a [new discussion](https://github.com/GuardianUI/guardianui/discussions).
+
+> **Note**
+>
+> **Please ask first before starting work on any significant new features. This includes things like ____, ____, ____, ____, etc.**
+>
+> It's never a fun experience to have your pull request declined after investing time and effort into a new feature. To avoid this from happening, we request that contributors create a [feature request](https://github.com/GuardianUI/guardianui/discussions/new?category=ideas) to first discuss any changes or significant new ideas.
+
+<br>
+
+## Basic guide
+
+This guide is intended to help you get started with contributing. By following these steps, you will understand the development process and workflow.
+
+1. [Cloning the repository](#cloning-the-repository)
+2. [Installing Node.js and pnpm](#installing-nodejs-and-pnpm)
+3. [Installing dependencies](#installing-dependencies)
+4. [Starting the development playground](#starting-the-development-playground)
+5. [Running the test suite](#running-the-test-suite)
+6. [Writing documentation](#writing-documentation)
+7. [Submitting a pull request](#submitting-a-pull-request)
+
+## Advanced guide
+
+This guide covers more advanced topics. Pick the topics based on your needs.
+
+8. [Versioning](#versioning)
+9. [Testing against React 17](#testing-against-react-17)
+
+<br>
+
+---
+
+<br>
+
+## Cloning the repository
+
+To start contributing to the project, clone it to your local machine using git:
+
+```bash
+git clone https://github.com/wagmi-dev/wagmi.git --recurse-submodules
+```
+
+Or the [GitHub CLI](https://cli.github.com):
+
+```bash
+gh repo clone wagmi-dev/wagmi -- --recurse-submodules
+```
+
+<div align="right">
+  <a href="#basic-guide">&uarr; back to top</a></b>
+</div>
+
+## Installing Node.js and pnpm
+
+wagmi uses [pnpm workspaces](https://pnpm.io/workspaces) to manage multiple projects. You need to install **Node.js v16 or higher** and **pnpm v7 or higher**.
+
+You can run the following commands in your terminal to check your local Node.js and npm versions:
+
+```bash
+node -v
+pnpm -v
+```
+
+If the versions are not correct or you don't have Node.js or pnpm installed, download and follow their setup instructions:
+
+- Install Node.js using [fnm](https://github.com/Schniz/fnm) or from the [official website](https://nodejs.org)
+- Install [pnpm](https://pnpm.io/installation)
+
+<div align="right">
+  <a href="#basic-guide">&uarr; back to top</a></b>
+</div>
+
+## Installing dependencies
+
+Once in the project's root directory, run the following command to install the project's dependencies:
+
+```bash
+pnpm install
+```
+
+After the install completes, pnpm links packages across the project for development and [git hooks](https://github.com/toplenboren/simple-git-hooks) are set up.
+
+<div align="right">
+  <a href="#basic-guide">&uarr; back to top</a></b>
+</div>
+
+## Starting the development playground
+
+To start the local development playground, run the following. This will run a [Next.js](https://nextjs.org) app (located at [`examples/_dev`](../examples/_dev)) that is set up for playing around with code while making changes.
+
+```bash
+pnpm playground
+```
+
+Once the Next.js dev server is running, you can make changes to any of the package source files (e.g. `packages/react`) and it will automatically update the playground. (If the playground isn't automatically updating, try running `pnpm dev` to relink packages in development mode.)
+
+<div align="right">
+  <a href="#basic-guide">&uarr; back to top</a></b>
+</div>
+
+## Running the test suite
+
+wagmi uses [Anvil](https://github.com/foundry-rs/foundry/tree/master/anvil) to execute tests against a local Ethereum node. First, install Anvil via [Foundry](https://book.getfoundry.sh/getting-started/installation). Next, add the following to your environment (recommended to use [`direnv`](https://github.com/direnv/direnv)):
+
+```bash
+ANVIL_FORK_URL=https://eth-mainnet.alchemyapi.io/v2/<apiKey>
+```
+
+`ANVIL_FORK_URL` can be for any RPC service provider (e.g. Alchemy or Infura). Now you are ready to run the tests! In one terminal session, spin up Anvil using `pnpm anvil`. Next, in a different terminal session, you have the following options for running tests:
+
+- `pnpm test` — runs tests in watch mode
+- `pnpm test:run` — performs single run without watch mode
+
+When adding new features or fixing bugs, it's important to add test cases to cover the new/updated behavior. If snapshot tests fail, you can run the `test:update` command to update the snapshots.
+
+<div align="right">
+  <a href="#basic-guide">&uarr; back to top</a></b>
+</div>
+
+## Writing documentation
+
+Documentation is crucial to helping developers of all experience levels use wagmi. wagmi uses [Nextra](https://github.com/shuding/nextra) and [MDX](https://mdxjs.com) for the documentation site (located at [`docs`](../docs)). To start the site in dev mode, run:
+
+```bash
+pnpm docs:dev
+```
+
+Try to keep documentation brief and use plain language so folks of all experience levels can understand. If you think something is unclear or could be explained better, you are welcome to open a pull request.
+
+<div align="right">
+  <a href="#basic-guide">&uarr; back to top</a></b>
+</div>
+
+## Submitting a pull request
+
+When you're ready to submit a pull request, you can follow these naming conventions:
+
+- Pull request titles use the [Imperative Mood](https://en.wikipedia.org/wiki/Imperative_mood) (e.g., `Add something`, `Fix something`).
+- [Changesets](#versioning) use past tense verbs (e.g., `Added something`, `Fixed something`).
+
+When you submit a pull request, GitHub will automatically lint, build, and test your changes. If you see an ❌, it's most likely a bug in your code. Please, inspect the logs through the GitHub UI to find the cause.
+
+<div align="right">
+  <a href="#basic-guide">&uarr; back to top</a></b>
+</div>
+
+<br>
+
+---
+
+<div align="center">
+  ✅ Now you're ready to contribute to GuardianUI! Follow the next steps if you need more advanced instructions.
+</div>
+
+---
+
+<br>
+
+## Versioning
+
+When adding new features or fixing bugs, we'll need to bump the package versions. We use [Changesets](https://github.com/changesets/changesets) to do this.
+
+> **Note**
+>
+> Only changes to the codebase that affect the public API or existing behavior (e.g. bugs) need changesets.
+
+Each changeset defines which package(s) should be published and whether the change should be a major/minor/patch release, as well as providing release notes that will be added to the changelog upon release.
+
+To create a new changeset, run `pnpm changeset`. This will run the Changesets CLI, prompting you for details about the change. You’ll be able to edit the file after it’s created — don’t worry about getting everything perfect up front.
+
+Since we’re currently in beta, all changes should be marked as a minor/patch release to keep us within the `v0.x` range.
+
+Even though you can technically use any markdown formatting you like, headings should be avoided since each changeset will ultimately be nested within a bullet list. Instead, bold text should be used as section headings.
+
+If your PR is making changes to an area that already has a changeset (e.g. there’s an existing changeset covering theme API changes but you’re making further changes to the same API), you should update the existing changeset in your PR rather than creating a new one.
+
+### Releasing
+
+The first time a PR with a changeset is merged after a release, a new PR will automatically be created called `chore: version packages`. Any subsequent PRs with changesets will automatically update this existing version packages PR. Merging this PR triggers the release process by publishing to npm and cleaning up the changeset files.
+
+### Creating a snapshot release
+
+If a PR has changesets, you can create a [snapshot release](https://github.com/changesets/changesets/blob/main/docs/snapshot-releases.md) by [manually dispatching](https://github.com/wagmi-dev/wagmi/actions/workflows/snapshot.yml) the Snapshot workflow. This publishes a tagged version to npm with the PR branch name and timestamp.
+
+<div align="right">
+  <a href="#advanced-guide">&uarr; back to top</a></b>
+</div>
+
+## Testing against React 17
+
+wagmi supports both React 17 and React 18. If you want to run tests against React 17, you can run the following commands.
+
+```bash
+cd packages/react
+pnpm add -D react@17.0.2 react-dom@17.0.2
+cd ../..
+pnpm test:run react
+```
+
+Unfortunately `pnpm` [doesn't support](https://github.com/pnpm/pnpm/issues/2020) a `--no-save` flag so you will need to restore the package.json and lockfile before committing your changes.
+
+<div align="right">
+  <a href="#advanced-guide">&uarr; back to top</a></b>
+</div>

ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,65 @@
+name: Bug Report
+description: File a bug/issue
+title: 'bug: <title>'
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! The more info you provide, the more we can help you. 
+
+  - type: checkboxes
+    attributes:
+      label: Is there an existing issue for this?
+      description: Please search to see if an issue already exists for the bug you encountered.
+      options:
+        - label: I have searched the existing issues
+          required: true
+
+  - type: input
+    attributes:
+      label: Package Version
+      description: What version of guardianui are you using?
+      placeholder: 1.0.0
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Current Behavior
+      description: A concise description of what you're experiencing.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: A concise description of what you expected to happen.
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Steps To Reproduce
+      description: Steps or code snippets to reproduce the behavior.
+    validations:
+      required: false
+
+  - type: input
+    attributes:
+      label: Link to Minimal Reproducible Example (StackBlitz, CodeSandbox, GitHub repo etc.)
+      description: |
+        Please provide a link via [new.wagmi.sh](https://new.wagmi.sh/) or a link to a minimal repository that can reproduce the problem you ran into. `npm create wagmi@latest` can also be used as a starter template.
+        This makes investigating issues and helping you out significantly easier! For most issues, you will likely get asked to provide one so why not add one now :)
+      placeholder: https://new.wagmi.sh/
+    validations:
+      required: false
+
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Browser info? Screenshots? Anything that will give us more context about the issue you are encountering!
+
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false