Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/general.yml
Original file line number Diff line number Diff line change
@@ -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.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/library-request.yml
Original file line number Diff line number Diff line change
@@ -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.
82 changes: 82 additions & 0 deletions .github/ISSUE_TEMPLATE/new-exploration.yml
Original file line number Diff line number Diff line change
@@ -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.
43 changes: 43 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## What does this PR do?

<!-- Briefly describe the change and its motivation. -->

## Related issue

<!-- Link the GitHub issue this PR addresses: Fixes #… / Relates to #… -->

## Type of change

<!-- Check all that apply. -->

- [ ] New exploration
- [ ] Improvement to an existing exploration
- [ ] New or updated E-Component
- [ ] Library addition or fork
- [ ] Documentation
- [ ] Bug fix
- [ ] Other: <!-- describe -->

## Taxonomy (new explorations only)

<!-- Fill in if adding a new exploration. See https://docs.feelyourprotocol.org/guide/architecture -->

- **Topic:** <!-- e.g. Scaling -->
- **Timeline:** <!-- e.g. Fusaka -->
- **Tags:** <!-- e.g. EVM, Gas Costs -->

## Checklist

<!-- Tick off what applies. Not every item is required for every PR. -->

- [ ] 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

<!-- Optional — include before/after screenshots or a screen recording if relevant. -->
4 changes: 2 additions & 2 deletions dist/docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
<link rel="preload stylesheet" href="/assets/style.Cfu23m_7.css" as="style">
<link rel="preload stylesheet" href="/vp-icons.css" as="style">

<script type="module" src="/assets/app.D547fiSf.js"></script>
<script type="module" src="/assets/app.BHgaHAgx.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"contributing_adding-an-exploration.md\":\"iBUUBPTj\",\"contributing_ai-assisted-development.md\":\"lydwZLlM\",\"contributing_available-e-components.md\":\"B4Q_z4Hi\",\"contributing_code-conventions.md\":\"C86y1S4H\",\"contributing_e-components.md\":\"PhGEgitZ\",\"contributing_how-to-contribute.md\":\"DneE9-kZ\",\"contributing_library-forks.md\":\"DYk1JQhp\",\"contributing_styling.md\":\"BKPSSvmJ\",\"contributing_ui-components.md\":\"vHxMK_fH\",\"guide_architecture.md\":\"B6eczQC1\",\"guide_getting-started.md\":\"BjX7SsDe\",\"index.md\":\"COXeFy5O\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Feel Your Protocol\",\"description\":\"Documentation for the Feel Your Protocol project\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Guide\",\"link\":\"/guide/getting-started\"},{\"text\":\"Contributing\",\"link\":\"/contributing/how-to-contribute\"},{\"text\":\"Website\",\"link\":\"https://feelyourprotocol.org\"}],\"sidebar\":[{\"text\":\"Guide\",\"items\":[{\"text\":\"Getting Started\",\"link\":\"/guide/getting-started\"},{\"text\":\"Architecture\",\"link\":\"/guide/architecture\"}]},{\"text\":\"Contributing\",\"items\":[{\"text\":\"How to Contribute\",\"link\":\"/contributing/how-to-contribute\"},{\"text\":\"AI-Assisted Development\",\"link\":\"/contributing/ai-assisted-development\"},{\"text\":\"Adding an Exploration\",\"link\":\"/contributing/adding-an-exploration\"},{\"text\":\"UI Components\",\"link\":\"/contributing/ui-components\"},{\"text\":\"E-Components\",\"link\":\"/contributing/e-components\"},{\"text\":\"Available E-Components\",\"link\":\"/contributing/available-e-components\"},{\"text\":\"Styling & Design\",\"link\":\"/contributing/styling\"},{\"text\":\"Code Conventions\",\"link\":\"/contributing/code-conventions\"},{\"text\":\"Library Forks\",\"link\":\"/contributing/library-forks\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/feelyourprotocol/website\"}],\"search\":{\"provider\":\"local\"},\"footer\":{\"message\":\"This project and its documentation are under active development.\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false,\"additionalConfig\":{}}");</script>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"contributing_adding-an-exploration.md\":\"CLO_TxsK\",\"contributing_ai-assisted-development.md\":\"lydwZLlM\",\"contributing_available-e-components.md\":\"B4Q_z4Hi\",\"contributing_code-conventions.md\":\"C86y1S4H\",\"contributing_e-components.md\":\"PhGEgitZ\",\"contributing_how-to-contribute.md\":\"G0y-xflE\",\"contributing_images.md\":\"DdK4lm4N\",\"contributing_styling.md\":\"BKPSSvmJ\",\"contributing_third-party-libraries.md\":\"DAoVaD5b\",\"contributing_ui-components.md\":\"vHxMK_fH\",\"guide_architecture.md\":\"B6eczQC1\",\"guide_getting-started.md\":\"BjX7SsDe\",\"index.md\":\"COXeFy5O\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Feel Your Protocol\",\"description\":\"Documentation for the Feel Your Protocol project\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"nav\":[{\"text\":\"Guide\",\"link\":\"/guide/getting-started\"},{\"text\":\"Contributing\",\"link\":\"/contributing/how-to-contribute\"},{\"text\":\"Website\",\"link\":\"https://feelyourprotocol.org\"}],\"sidebar\":[{\"text\":\"Guide\",\"items\":[{\"text\":\"Getting Started\",\"link\":\"/guide/getting-started\"},{\"text\":\"Architecture\",\"link\":\"/guide/architecture\"}]},{\"text\":\"Contributing\",\"items\":[{\"text\":\"How to Contribute\",\"link\":\"/contributing/how-to-contribute\"},{\"text\":\"AI-Assisted Development\",\"link\":\"/contributing/ai-assisted-development\"},{\"text\":\"Adding an Exploration\",\"link\":\"/contributing/adding-an-exploration\"},{\"text\":\"Images\",\"link\":\"/contributing/images\"},{\"text\":\"UI Components\",\"link\":\"/contributing/ui-components\"},{\"text\":\"E-Components\",\"link\":\"/contributing/e-components\"},{\"text\":\"Available E-Components\",\"link\":\"/contributing/available-e-components\"},{\"text\":\"Styling & Design\",\"link\":\"/contributing/styling\"},{\"text\":\"Code Conventions\",\"link\":\"/contributing/code-conventions\"},{\"text\":\"Third-Party Libraries\",\"link\":\"/contributing/third-party-libraries\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/feelyourprotocol/website\"}],\"search\":{\"provider\":\"local\"},\"footer\":{\"message\":\"This project and its documentation are under active development.\"}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false,\"additionalConfig\":{}}");</script>

</body>
</html>
Loading