Merge pull request #18 from xmtp/rygine/changesets

Use changesets for releases

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": [
+    "@changesets/changelog-git",
+    {
+      "repo": "xmtp/snap"
+    }
+  ],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": ["@xmtp/snap-site"]
+}

.github/workflows/release.yml

@@ -6,32 +6,36 @@ on:
       - beta
 jobs:
   release:
-    name: Release
-    runs-on: ubuntu-latest
     permissions:
       id-token: write
       contents: write
-      pull-requests: write
       issues: write
+      pull-requests: write
+    name: Release
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
+          # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
           fetch-depth: 0
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
           cache: 'yarn'
         env:
-          SKIP_YARN_COREPACK_CHECK: "1"
+          SKIP_YARN_COREPACK_CHECK: '1'
       - name: Enable corepack
         run: corepack enable
       - name: Install dependencies
         run: yarn
-      - name: Release
-        working-directory: packages/snap
+      - name: Publish
+        uses: changesets/action@v1
+        with:
+          title: 'release: version packages'
+          commit: 'release: version packages'
+          publish: yarn publish
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: yarn dlx semantic-release

.gitignore

@@ -1,77 +1,54 @@
-.DS_Store
-dist/
-build/
-coverage/
-.cache/
-public/
-
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
 
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+# dependencies
+node_modules
 
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Coverage directory used by tools like istanbul
+# testing
 coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
 
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
+# misc
+.DS_Store
+*.pem
 
-# Output of 'npm pack'
-*.tgz
+# debug
+yarn-debug.log*
+yarn-error.log*
 
-# Yarn Integrity file
-.yarn-integrity
+# local env files
+.env*
 
-# dotenv environment variables file
-.env
-.env.test
+# turbo
+.turbo
 
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
+# logs
+logs
+*.log
 
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
+# editor directories and files
+.vscode/*
+!.vscode/extensions.json
+!.vscode/settings.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+# build artifacts
+lib
+dist
+build
+
+# yarn
 .pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# typedocs
+docs

.node-version

@@ -0,0 +1 @@
+18.14.0

.nvmrc

@@ -1 +1 @@
-v18
+18.14.0

CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# XMTP code of conduct
+
+This code of conduct applies within all XMTP community spaces, virtual and physical, and also applies when an individual is officially representing the XMTP community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Our pledge
+
+We as members 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, caste, color, 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 conduct
+
+Examples of behaviors that contribute to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being collaborative and respectful of differing opinions, viewpoints, and experiences. A great protocol is built by many contributors learning and working together.
+- Being bold yet intentional when presenting ideas. We are here to help ensure the world has access to secure and private communication, while also acknowledging that building successful protocols and ecosystems requires the application of logic and evidence.
+- 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, and the people depending on XMTP for communication.
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Hate speech, trolling, shitposting, flaming, spamming, unsolicited advertising, baiting, 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
+
+## Moderation
+
+Community moderators 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 moderators have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this code of conduct and will communicate reasons for moderation decisions when appropriate.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior can be reported to the community moderators responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. All community moderators are obligated to respect the privacy and security of the reporter of any incident.
+
+Community moderators who do not follow or enforce the code of conduct in good faith may face temporary or permanent repercussions as determined by other community moderators.
+
+## Attribution
+
+The XMTP code of conduct is adapted from the Contributor Covenant, [version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html) and [version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).

CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing
+
+Thank you for considering contributing to this repo! Community contributions like yours are key to the development and adoption of XMTP. Your questions, feedback, suggestions, and code contributions are welcome!
+
+## ❔ Questions
+
+Have a question about how to build with XMTP? Ask your question and learn with the community in the [XMTP Community Forums](https://community.xmtp.org/).
+
+## 🐞 Bugs
+
+Report a bug using [GitHub Issues](https://github.com/xmtp/snap/issues).
+
+## ✨ Feature requests
+
+Request a feature using [GitHub Issues](https://github.com/xmtp/snap/issues).
+
+## 🔀 Pull requests
+
+PRs are encouraged, but consider starting with a feature request to temperature-check first. If the PR involves a major change to the protocol, the work should be fleshed out as an [XMTP Improvement Proposal](https://community.xmtp.org/t/xip-0-xip-purpose-process-guidelines/475) before work begins.
+
+After a pull request is submitted, a single approval is required to merge it.
+
+## 🔧 Developing
+
+### Prerequisites
+
+#### Node
+
+Please make sure you have a compatible version as specified in `.nvmrc` or `.node-version`. We recommend using a Node version manager such as [nvm](https://github.com/nvm-sh/nvm) or [nodenv](https://github.com/nodenv/nodenv).
+
+#### Yarn
+
+This repository uses the [Yarn package manager](https://yarnpkg.com/). To use it, enable [Corepack](https://yarnpkg.com/corepack), if it isn't already, by running `corepack enable`.
+
+### Useful commands
+
+- `yarn`: Installs all dependencies
+- `yarn build`: Builds the `packages/snap` package
+- `yarn clean`: Remove all `node_modules`, `.turbo`, and build folders, clear Yarn cache
+- `yarn dev`: Builds `packages/snap`, then runs the `packages/site` example in dev mode.
+- `yarn format`: Run prettier format and write changes on all packages
+- `yarn format:check`: Run prettier format check on all packages
+- `yarn lint`: Lint all packages
+- `yarn test`: Test all packages
+- `yarn typecheck`: Typecheck all packages
+
+### Testing and validation
+
+Please add unit tests when appropriate and ensure that all unit tests are passing before submitting a pull request. Note that some unit tests require a backend node to be running locally. The `test:setup` command can be run a single time to start the node in the background using Docker.
+
+Manual validation requires running a client app such as this [example app](/examples/react-vite/). The example apps use their associated SDK located in this repo. SDKs must be built before running one of its example apps. To see updates in realtime, build the SDK in watch mode, which will watch for changes and trigger a rebuild.
+
+### Notes
+
+Babel is used for transpiling TypeScript to JavaScript. When building with the CLI, `transpilationMode` must be set to `localAndDeps` to include `xmtp-js` in the transpilation, which is required for the Snap to build properly.
+
+## 🚢 Publishing
+
+This repository uses [changesets](https://github.com/changesets/changesets) to publish updates. Pull requests must contain a changeset in order for changes to be published. The [changeset-bot](https://github.com/apps/changeset-bot) will guide you through this process.

README.md

@@ -1,4 +1,4 @@
-# @xmtp/snap
+# @xmtp/snap-monorepo
 
 This repository contains the XMTP Snap, released via NPM here, as well as a small webapp to demo the functionality. It was generated using the [template-snap repository](https://github.com/MetaMask/template-snap-monorepo/generate)
 
@@ -32,26 +32,6 @@ The built-in Snap storage is used for three tasks:
 
 Both `2` and `3` are highly sensitive material. At no time should these materials be accessible outside the Snap (via RPCs, console.log, or any other mechanism). It should not be possible to manipulate the values in `1` outside of the mechanisms described in [Authentication](#authentication).
 
-## Getting Started
+## Contributing
 
-You can start both the snap and the example site by running:
-
-```shell
-npm install
-npm start
-```
-
-### Testing and Linting
-
-Run `npm test` to run the tests once.
-
-Run `npm run lint` to run the linter, or run `npm run lint:fix` to run the linter and fix any automatically fixable issues.
-
-### Releasing & Publishing
-
-This project uses [semantic-release](https://semantic-release.gitbook.io/semantic-release/v/beta/) to publish new versions of the Snap. For changes that modify the Snap itself (not the website), follow the [Angular Commit Conventions](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format) in your commits.
-
-## Notes
-
-- Babel is used for transpiling TypeScript to JavaScript. When building with the CLI,
-  `transpilationMode` must be set to `localAndDeps` to include `xmtp-js` in the transpilation, which is required for the Snap to build properly.
+See our [contribution guide](./CONTRIBUTING.md) to learn more about contributing to this project.