Skip to content
Open
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
181 changes: 181 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
name: Bug Report
description: Report a bug or unexpected behavior
title: "[Bug]: "
labels: ["bug", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the information below to help us resolve the issue.

- type: textarea
id: description
attributes:
label: Describe the bug
description: A clear description of what the bug is
placeholder: When I do X, Y happens instead of Z
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: Steps to reproduce
description: Detailed steps to reproduce the behavior
placeholder: |
1. Create a container with...
2. Execute code...
3. See error
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: What you expected to happen
placeholder: I expected the code to execute successfully
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual behavior
description: What actually happened (include error messages if any)
placeholder: Got error "Cannot find module 'fs'"
validations:
required: true

- type: dropdown
id: component
attributes:
label: Which component is affected?
description: Select all that apply
multiple: true
options:
- Runtime / Code execution
- Virtual File System (VFS)
- Node.js API shims (fs, path, http, etc.)
- npm package installation
- Vite dev server
- Next.js dev server
- Service Worker
- Web Worker / Sandbox
- TypeScript transformation
- Hot Module Replacement (HMR)
- Documentation
- Other
validations:
required: true

- type: input
id: almostnode-version
attributes:
label: almostnode version
description: Run `npm list almostnode` or check package.json
placeholder: "0.2.11"
validations:
required: true

- type: input
id: node-version
attributes:
label: Node.js version
description: Run `node --version`
placeholder: "v20.10.0"
validations:
required: true

- type: dropdown
id: browser
attributes:
label: Browser
options:
- Chrome
- Firefox
- Safari
- Edge
- Other
validations:
required: true

- type: input
id: browser-version
attributes:
label: Browser version
placeholder: "Chrome 120.0.0"

- type: dropdown
id: os
attributes:
label: Operating System
options:
- macOS
- Windows
- Linux
- Other
validations:
required: true

- type: dropdown
id: mode
attributes:
label: Execution mode
options:
- Same-origin (dangerouslyAllowSameOrigin)
- Cross-origin sandbox
- Web Worker
- Main thread
- Not applicable
validations:
required: true

- type: textarea
id: code
attributes:
label: Minimal reproduction code
description: Provide the smallest code snippet that reproduces the issue
render: typescript
placeholder: |
import { createRuntime } from 'almostnode';
import { VirtualFS } from 'almostnode';

const vfs = new VirtualFS();
const runtime = await createRuntime(vfs);
const result = await runtime.execute(`
const fs = require('fs');
// Bug happens here
`);

- type: textarea
id: logs
attributes:
label: Console output / Error logs
description: Include relevant console output or error messages
render: shell
placeholder: |
Error: Cannot find module 'fs'
at Runtime.require (runtime.ts:123)

- type: textarea
id: additional
attributes:
label: Additional context
description: Any other context, screenshots, or information that might help
placeholder: |
- This started happening after upgrading to version X
- Works fine in Chrome but fails in Safari
- Screenshot: [attach image]

- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
options:
- label: I have searched existing issues to avoid duplicates
required: true
- label: I have tested with the latest version of almostnode
required: true
- label: I have included a minimal reproduction
required: true
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
blank_issues_enabled: false
contact_links:
- name: Question or Discussion
url: https://github.com/macaly/almostnode/discussions
about: Ask questions or discuss ideas with the community
- name: Documentation
url: https://github.com/macaly/almostnode#readme
about: Check the documentation for usage guides and examples
- name: Macaly Support
url: https://macaly.com
about: Visit Macaly.com for more information
131 changes: 131 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
name: Feature Request
description: Suggest a new feature or enhancement
title: "[Feature]: "
labels: ["enhancement", "needs-triage"]
body:
- type: markdown
attributes:
value: |
Thanks for suggesting a feature! Please provide as much detail as possible to help us understand your request.

- type: textarea
id: problem
attributes:
label: Problem statement
description: What problem does this feature solve? What's the use case?
placeholder: |
I'm trying to build a code playground where users can...
Currently, I have to manually...
This is frustrating because...
validations:
required: true

- type: textarea
id: solution
attributes:
label: Proposed solution
description: How would you like this feature to work?
placeholder: |
I would like to be able to...
The API could look like...
This would allow me to...
validations:
required: true

- type: dropdown
id: feature-area
attributes:
label: Which area does this feature relate to?
description: Select all that apply
multiple: true
options:
- Runtime / Code execution
- Virtual File System (VFS)
- Node.js API shims
- npm package installation
- Vite integration
- Next.js integration
- Service Worker
- Web Worker / Sandbox
- TypeScript support
- Hot Module Replacement (HMR)
- Security / Isolation
- Performance
- Developer Experience (DX)
- Documentation
- Examples
- Other
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered
description: What other solutions or workarounds have you considered?
placeholder: |
I tried using...
I could work around this by...
Other tools like X do this by...

- type: textarea
id: examples
attributes:
label: Examples from other tools
description: Are there similar features in other tools that inspired this request?
placeholder: |
WebContainers has a feature where...
StackBlitz allows you to...
CodeSandbox shows...

- type: dropdown
id: priority
attributes:
label: How important is this feature to you?
options:
- Critical - Blocking my work
- High - Would significantly improve my workflow
- Medium - Nice to have
- Low - Minor improvement
validations:
required: true

- type: textarea
id: api-design
attributes:
label: API design (if applicable)
description: If this is an API change, show how you'd like it to work
render: typescript
placeholder: |
// Proposed API
const container = createContainer({
newOption: true
});

- type: textarea
id: additional
attributes:
label: Additional context
description: Any other context, mockups, or examples
placeholder: |
Here's a mockup of how it could look...
This would be especially useful for...
Related to issue #123

- type: checkboxes
id: contribution
attributes:
label: Contribution
options:
- label: I'm willing to submit a PR to implement this feature
required: false

- type: checkboxes
id: checklist
attributes:
label: Pre-submission checklist
options:
- label: I have searched existing issues to avoid duplicates
required: true
- label: This feature aligns with almostnode's goal of bringing Node.js to the browser
required: true
45 changes: 45 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Code of Conduct

## Our Pledge

We as members, contributors, and leaders 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, 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 Standards

Examples of behavior that contributes to a positive environment for our community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* 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

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of any kind
* Trolling, 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
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Enforcement Responsibilities

Project maintainers 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.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the project team at support@macaly.com. All complaints will be reviewed and investigated promptly and fairly.

All project team members are obligated to respect the privacy and security of the reporter of any incident.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Loading