diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..978b083 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,51 @@ +name: "\U0001F41B Bug Report" +description: Report a bug on the website or in the framework. +title: "[Bug] " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thank you for reporting a bug. Please provide enough detail so we can reproduce and fix it. + + - type: input + id: url + attributes: + label: Page URL + description: The URL where you encountered the bug (if applicable). + placeholder: "https://feelyourprotocol.org/eip-7883-modexp-gas-cost-increase" + + - type: textarea + id: description + attributes: + label: What happened? + description: Describe the bug and what you expected to happen instead. + validations: + required: true + + - type: textarea + id: steps + attributes: + label: Steps to reproduce + description: Numbered steps to trigger the bug. + placeholder: | + 1. Go to … + 2. Click on … + 3. See error … + + - type: dropdown + id: browser + attributes: + label: Browser + options: + - Chrome + - Firefox + - Safari + - Edge + - Other + + - type: textarea + id: context + attributes: + label: Additional context + description: Screenshots, console errors, or anything else that helps. diff --git a/.github/ISSUE_TEMPLATE/general.yml b/.github/ISSUE_TEMPLATE/general.yml new file mode 100644 index 0000000..a774aab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/general.yml @@ -0,0 +1,25 @@ +name: "\U0001F4AC General / Question" +description: Ask a question, suggest an improvement, or discuss an idea. +title: "[Discussion] " +labels: ["discussion"] +body: + - type: markdown + attributes: + value: | + Use this template for questions, feature ideas, or anything that doesn't fit the other templates. + + **Docs:** [How to Contribute](https://docs.feelyourprotocol.org/contributing/how-to-contribute) · [Architecture](https://docs.feelyourprotocol.org/guide/architecture) + + - type: textarea + id: description + attributes: + label: What's on your mind? + description: Describe your question, idea, or suggestion. + validations: + required: true + + - type: textarea + id: context + attributes: + label: Additional context + description: Links, screenshots, or references that help explain. diff --git a/.github/ISSUE_TEMPLATE/library-request.yml b/.github/ISSUE_TEMPLATE/library-request.yml new file mode 100644 index 0000000..702511e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/library-request.yml @@ -0,0 +1,54 @@ +name: "\U0001F4E6 Library Request" +description: Request adding a new dependency or setting up a managed fork. +title: "[Library] " +labels: ["library"] +body: + - type: markdown + attributes: + value: | + Use this template to request a new third-party dependency or a managed fork branch. + + **Docs:** [Third-Party Libraries](https://docs.feelyourprotocol.org/contributing/third-party-libraries) + + - type: dropdown + id: type + attributes: + label: Request type + options: + - "Add a new npm dependency" + - "Create a managed fork branch" + - "Other / not sure" + validations: + required: true + + - type: input + id: library + attributes: + label: Library name & URL + description: Name of the npm package and link to its repository. + placeholder: "e.g. @noble/curves — https://github.com/paulmillr/noble-curves" + validations: + required: true + + - type: input + id: exploration + attributes: + label: Related exploration + description: Which exploration will use this library? + placeholder: "e.g. eip-7951 (secp256r1)" + + - type: textarea + id: description + attributes: + label: What do you need? + description: | + For new dependencies: why is this library needed and can it be used unmodified? + For managed forks: what modifications are required and on which branch? + validations: + required: true + + - type: textarea + id: context + attributes: + label: Additional context + description: Links to your fork branch, related issues, or anything else. diff --git a/.github/ISSUE_TEMPLATE/new-exploration.yml b/.github/ISSUE_TEMPLATE/new-exploration.yml new file mode 100644 index 0000000..bc2d5e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-exploration.yml @@ -0,0 +1,82 @@ +name: "\U0001F680 New Exploration" +description: Propose a new interactive exploration for an EIP, protocol change, or research topic. +title: "[Exploration] " +labels: ["exploration"] +body: + - type: markdown + attributes: + value: | + Thanks for proposing a new exploration! Please fill out the sections below so we can discuss scope, library needs, and taxonomy placement before you start coding. + + **Docs:** [Adding an Exploration](https://docs.feelyourprotocol.org/contributing/adding-an-exploration) · [Architecture](https://docs.feelyourprotocol.org/guide/architecture) + + - type: input + id: eip + attributes: + label: EIP / Spec Reference + description: Link to the EIP, research paper, or forum post this exploration is based on. + placeholder: "https://eips.ethereum.org/EIPS/eip-XXXX" + validations: + required: true + + - type: textarea + id: description + attributes: + label: What should the exploration show? + description: Brief description of the interactive widget and what users will learn. + validations: + required: true + + - type: dropdown + id: topic + attributes: + label: Topic + description: "Which strategic pillar does this belong to? See [Topics](https://docs.feelyourprotocol.org/guide/architecture#topics)." + options: + - Scaling + - Privacy + - UX + - Security + - Robustness + - Interoperability + - "Not sure — need guidance" + validations: + required: true + + - type: dropdown + id: timeline + attributes: + label: Timeline + description: "Where does this sit on the protocol timeline? See [Timeline](https://docs.feelyourprotocol.org/guide/architecture#timeline)." + options: + - Fusaka + - Glamsterdam + - Ready + - Research + - Ideas + - "Not sure — need guidance" + validations: + required: true + + - type: input + id: tags + attributes: + label: Tags (up to 3–4) + description: "Existing tags or proposed new ones. See [Tags](https://docs.feelyourprotocol.org/guide/architecture#tags) for rules." + placeholder: "e.g. EVM, Gas Costs, Precompiles" + + - type: textarea + id: libraries + attributes: + label: Library needs + description: | + Which libraries will the exploration use? Are they already in `package.json`? Do you need a custom fork or new dependency? + + See [Third-Party Libraries](https://docs.feelyourprotocol.org/contributing/third-party-libraries) for the process. + placeholder: "e.g. @ethereumjs/evm (already available), noble-curves (needs adding)" + + - type: textarea + id: context + attributes: + label: Additional context + description: Anything else — mockups, related explorations, open questions. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..bf7280e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,43 @@ +## What does this PR do? + + + +## Related issue + + + +## Type of change + + + +- [ ] New exploration +- [ ] Improvement to an existing exploration +- [ ] New or updated E-Component +- [ ] Library addition or fork +- [ ] Documentation +- [ ] Bug fix +- [ ] Other: + +## Taxonomy (new explorations only) + + + +- **Topic:** +- **Timeline:** +- **Tags:** + +## Checklist + + + +- [ ] I have read the [contributing guide](https://docs.feelyourprotocol.org/contributing/how-to-contribute) +- [ ] Linting and type checking pass (`npm run lf && npm run type-check`) +- [ ] Unit tests pass (`npx vitest run`) +- [ ] E2E tests pass (`npm run test:e2e`) +- [ ] Production build succeeds (`npm run build`) +- [ ] New exploration is registered in `REGISTRY.ts` +- [ ] Library needs were discussed in a separate issue (if applicable — see [Third-Party Libraries](https://docs.feelyourprotocol.org/contributing/third-party-libraries)) + +## Screenshots / recordings + + diff --git a/dist/docs/404.html b/dist/docs/404.html index 5f5ec4e..e986ee9 100644 --- a/dist/docs/404.html +++ b/dist/docs/404.html @@ -9,14 +9,14 @@ - +
- +