From db5d5373ce6af5622f2f5ef245de9f7b296589b8 Mon Sep 17 00:00:00 2001 From: koji Date: Thu, 17 Sep 2026 20:10:15 -0400 Subject: [PATCH 1/2] docs: add contribution guidance to README --- docs/README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/README.md b/docs/README.md index 99ccc25..73eff6c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -84,3 +84,49 @@ If you encounter any errors or bugs, please report them to the #visualization-ex ## 4. License MIT License © 2026 Koji Kanao + + +--- + +## 5. Contributing + +This section is for contributing to this website. The [Prerequisites](#1-prerequisites) above are for using the extension and are not needed for website development. + +### Propose a change + +1. Check existing [issues](https://github.com/koji/protocol-visualizer-web/issues) and [pull requests](https://github.com/koji/protocol-visualizer-web/pulls) to see whether the change is already being discussed. +2. Open an issue describing the problem and the change you intend to make. For substantial changes, please discuss the approach in the issue before implementing it. + +### Set up the project + +The website is built with [Vite](https://vite.dev) and React. You need Node.js LTS and pnpm 10: + +```bash +# from the repository root +pnpm install --frozen-lockfile +pnpm run dev +``` + +`pnpm run dev` starts a local dev server, by default at http://localhost:5173. + +### Verify your change + +Run these from the repository root before opening a pull request: + +```bash +pnpm run lint +pnpm run format:check +pnpm run test +pnpm run build +``` + +`pnpm run build` also runs the TypeScript compiler. The same checks run in CI. + +### Open a pull request + +1. Create a focused branch, commit your change, and push the branch to your fork. +2. Open a pull request against the default branch, linking the issue that describes the change. +3. Include a short summary of the change and the verification results. For visual changes, include before/after screenshots. +4. A maintainer will review your pull request, so please respond to review feedback. + +--- From 60f8219e5008c44c6be37d03a90ba49a8e79243b Mon Sep 17 00:00:00 2001 From: koji Date: Fri, 18 Sep 2026 02:12:55 -0400 Subject: [PATCH 2/2] chore: ignore .artifacts folder --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index e5537be..1e1bb08 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ node_modules/ dist/ *.local +".artifacts/"