General workspace improvements

.changeset/blue-pumpkins-live.md

@@ -0,0 +1,5 @@
+---
+'@scio-labs/use-inkathon': minor
+---
+
+Complete README overhaul and addition of CONTRIBUTING guidelines

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": ["@changesets/changelog-github", { "repo": "scio-labs/use-inkathon" }],
+  "commit": true,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/dull-melons-walk.md

@@ -0,0 +1,5 @@
+---
+'@scio-labs/use-inkathon': minor
+---
+
+Types refactorings into dedicated files

.changeset/thirty-ravens-swim.md

@@ -0,0 +1,5 @@
+---
+'@scio-labs/use-inkathon': minor
+---
+
+Setup & workspace improvements

.eslintignore

@@ -1,4 +1,3 @@
-package-lock.json
 node_modules
 dist
 docs

.github/workflows/add-to-project.yml

@@ -6,10 +6,10 @@ on:
     types:
       - opened
       - reopened
-  pull_request:
-    types:
-      - opened
-      - reopened
+  # pull_request:
+  #   types:
+  #     - opened
+  #     - reopened
 
 jobs:
   add-to-project:

.github/workflows/release.yml

@@ -0,0 +1,50 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [18]
+        pnpm-version: [8.8]
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+        with:
+          # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
+          fetch-depth: 0
+          submodules: true
+
+      - name: Set up pnpm action ${{ matrix.pnpm-version }}
+        uses: pnpm/action-setup@v2
+        with:
+          version: ${{ matrix.pnpm-version }}
+
+      - name: Set up Node ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          cache: 'pnpm'
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install Dependencies
+        run: pnpm install --lockfile-only
+
+      - name: Create Release Pull Request
+        uses: changesets/action@v1
+        with:
+          title: 'chore(changeset): Bump version & Update docs'
+          commit: 'chore(changeset): Bump version & Update docs'
+          version: pnpm run changeset:version
+          publish: pnpm run changeset:publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.CHANGESETS_PAT }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -20,11 +20,8 @@ yarn-error.log*
 .pnpm-debug.log*
 
 # local env files
-.env
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
+*.env*
+!.env*.example
 
 # vercel
 .vercel

.lintstagedrc.json

@@ -1,4 +1,4 @@
 {
-  "*.{js,ts}": ["eslint --fix", "prettier --write"],
-  "*.{md,json,yml,yaml}": "prettier --write"
+  "*.{js,jsx,ts,tsx}": ["pnpm run lint:fix"],
+  "*.{json,md,mdx,html,css,yml,yaml}": ["pnpm run lint:format"]
 }

.nvmrc

@@ -1 +1 @@
-v16
+v18

.prettierignore

@@ -1,5 +1,7 @@
-LICENSE
 package-lock.json
+pnpm-lock.yaml
 node_modules
+LICENSE
 dist
-docs
+docs
+src/metadata

.husky/pre-commit → .simple-git-hooks.js

@@ -1,7 +1,8 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
+module.exports = {
+  'pre-commit': `
 export NVM_DIR="$HOME/.nvm"
 [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
 
-npx lint-staged
+pnpm lint-staged
+  `,
+}

.vscode/settings.json

@@ -1,18 +1,19 @@
 {
-  "files.exclude": {
-    "**/node_modules/": true,
-    "**/package-lock.json": true
-  },
   "search.exclude": {
+    "**/*.{jpg,jpeg,png,svg,webm,mp4,ttf,woff,woff2}": true,
     "docs": true
   },
   "search.useIgnoreFiles": true,
   "search.useGlobalIgnoreFiles": true,
   "search.useParentIgnoreFiles": true,
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
   "editor.formatOnSave": true,
   "editor.codeActionsOnSave": {
     "source.organizeImports": true,
     "source.fixAll.eslint": true
-  }
+  },
+  "[javascriptreact][typescriptreact][javascript][typescript][markdown][html][css][scss][sass][json][jsonc][yaml]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "typescript.updateImportsOnFileMove.enabled": "always",
+  "javascript.updateImportsOnFileMove.enabled": "always"
 }

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing Guidelines
+
+[Scio Labs](https://scio.xyz) actively welcomes contributions from anyone to make this a community-driven effort. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code.
+
+Our ink! developer tooling initiative is made up of the following projects:
+
+- `create-ink-app` CLI (_Coming soon_)
+- [`ink!athon`](https://github.com/scio-labs/inkathon) Boilerplate
+- [`useInkathon`](https://github.com/scio-labs/use-inkathon) Hooks & Utility Library
+- [`zink!`](https://github.com/scio-labs/zink) Smart Contract Macros
+
+_To ensure a smooth and efficient collaboration, please follow the guidelines below._
+
+## Issues
+
+- Before starting work, please check the existing issues for your planned feature or bug fix.
+- If there isn't an existing issue, create one. This allows us to avoid duplicate work and discuss the implementation details upfront.
+- If you want to work on an issue, please comment on it to let us know. This helps us keep track of who is working on what.
+
+## Pull Requests
+
+- All changes should be made through pull requests (PRs).
+- Please ensure your PR is linked to the relevant issue.
+- Include a clear and detailed description of the changes in your PR.
+- Request a review once your PR is ready.
+
+## Code Style
+
+- Please follow the existing coding style.
+- Make sure your changes pass the lint checks.
+
+> [!IMPORTANT]
+>
+> - Please install all recommended VSCode extensions (see `.vscode/extensions.json`).
+> - After installing dependencies, enable the `pre-commit` hook in your local repository via `pnpm simple-git-hooks`.
+
+## Communication
+
+- Be respectful and considerate in all interactions.
+- If you have questions or need help, don't hesitate to ask.
+- For code, feature, or bug discussions, please use the relevant GitHub issue or PR.
+- To chat with us or ask questions, join our [Telegram Group](https://t.me/inkathon). 💬
+
+Thanks for your contributions! 🙏