Skip to main content

Reporting Issues

Bug reports​

When reporting bugs, please include:

  1. Clear description of the issue
  2. Steps to reproduce the problem
  3. Expected behavior vs actual behavior
  4. Environment details (OS, Node.js version, etc.)
  5. Code example that demonstrates the issue
Bug Report Template
## Bug Description
Brief description of what went wrong.

## Steps to Reproduce

1. Create a component with...
2. Call lens.useRefraction()...
3. Observe the error...

## Expected Behavior

The component should...

## Actual Behavior

Instead, the component...

## Environment

- Refract version: 1.0.0
- Node.js version: 18.0.0
- Operating System: macOS 13.0
- Browser: Chrome 108.0

## Code Example

\`\`\`javascript
const BuggyComponent = createComponent(({ lens }) => {
  // Code that reproduces the issue
});
\`\`\`

## Additional Context

Any other relevant information...

Feature requests​

For feature requests, please include:

  1. Problem description - What problem does this solve?
  2. Proposed solution - How should it work?
  3. Use cases - When would this be useful?
  4. Examples - Show how to use it
  5. Alternatives - What other solutions exist?