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
72 changes: 52 additions & 20 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,70 @@
---
name: Bug report
name: Bug Report
about: Create a report to help us improve
title: ''
labels: ''
title: '[BUG] '
labels: 'bug'
assignees: ''

---

**Describe the bug**
## Bug Description

Check notice on line 9 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L9

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Bug Description
## Bug Description

A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
## Steps to Reproduce
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
## Expected Behavior
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.
## Actual Behavior

Check notice on line 21 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L21

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Actual Behavior
## Actual Behavior

A clear and concise description of what actually happened.

## Environment Information

Check notice on line 24 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L24

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Environment Information
## Environment Information

- **Onchain Test Kit Version**: [e.g., 1.2.0]

Check notice on line 25 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L25

Lists should be surrounded by blank lines

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Lists should be surrounded by blank lines

Suggested change
- **Onchain Test Kit Version**: [e.g., 1.2.0]
- **Onchain Test Kit Version**: [e.g., 1.2.0]

- **Node.js Version**: [e.g., 18.17.0]
- **Operating System**: [e.g., macOS 13.4, Windows 11, Ubuntu 20.04]
- **Browser**: [e.g., Chrome 115, Firefox 116]
- **Wallet**: [e.g., MetaMask, Coinbase Wallet, Phantom]

## Configuration Used

Check notice on line 31 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L31

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Configuration Used
## Configuration Used

```typescript
// Paste your configuration code here
const config = configure()
.withMetaMask()
// ... other configuration
.build();
```

## Error Logs

Check notice on line 40 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L40

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Error Logs
## Error Logs

```
Paste any error messages, stack traces, or relevant logs here
```

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
## Code Sample

Check notice on line 45 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L45

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Code Sample
## Code Sample

```typescript
// Minimal code example that reproduces the issue
import { createOnchainTest, configure } from '@coinbase/onchaintestkit';

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
const test = createOnchainTest(/* your config */);

**Additional context**
test('failing test', async ({ page, metamask }) => {
// Steps that cause the bug
});
```

## Screenshots

Check notice on line 57 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L57

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Screenshots
## Screenshots

If applicable, add screenshots to help explain your problem.

## Additional Context

Check notice on line 60 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L60

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Additional Context
## Additional Context

Add any other context about the problem here.

## Possible Solution

Check notice on line 63 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L63

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Possible Solution
## Possible Solution

If you have suggestions on how to fix the bug, please describe them here.

## Checklist

Check notice on line 66 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L66

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Checklist
## Checklist

- [ ] I have searched for existing issues that describe this bug

Check notice on line 67 in .github/ISSUE_TEMPLATE/bug_report.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/bug_report.md#L67

Lists should be surrounded by blank lines

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Lists should be surrounded by blank lines

Suggested change
- [ ] I have searched for existing issues that describe this bug
- [ ] I have searched for existing issues that describe this bug

- [ ] I have included all the required environment information
- [ ] I have provided a minimal code example that reproduces the issue
- [ ] I have included relevant error messages and logs
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Documentation Issue
about: Report an issue with documentation or request documentation improvements
title: "[DOCS] "
labels: documentation
title: '[DOCS] '
labels: 'documentation'
assignees: ''

---

## Documentation Issue Type
Expand Down Expand Up @@ -66,4 +65,4 @@ If requesting examples or reporting broken code:
- [ ] I have searched for existing documentation issues
- [ ] I have checked if this is covered in other sections
- [ ] I have provided specific suggestions for improvement
- [ ] I have included relevant code examples (if applicable)
- [ ] I have included relevant code examples (if applicable)
80 changes: 68 additions & 12 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,76 @@
---
name: Feature request
name: Feature Request
about: Suggest an idea for this project
title: ''
labels: ''
title: '[FEATURE] '
labels: 'enhancement'
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
## Feature Summary

Check notice on line 9 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L9

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Feature Summary
## Feature Summary

A clear and concise description of the feature you'd like to see added.

## Problem Statement
Describe the problem this feature would solve. Is your feature request related to a problem? Please describe.
Example: "I'm always frustrated when [...]"

## Proposed Solution
Describe the solution you'd like. A clear and concise description of what you want to happen.

## API Design (if applicable)

Check notice on line 19 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L19

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## API Design (if applicable)
## API Design (if applicable)

If this involves API changes, provide examples of how the new feature would be used:

```typescript
// Example of how the new feature would work
const config = configure()
.withNewFeature({
// configuration options
})
.build();

// or

await wallet.handleAction('newAction', {
// action parameters
});
```

## Alternatives Considered

Check notice on line 37 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L37

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Alternatives Considered
## Alternatives Considered

Describe any alternative solutions or features you've considered.

## Use Cases

Check notice on line 40 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L40

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Use Cases
## Use Cases

Describe specific use cases for this feature:
1. **Use Case 1**: Description of scenario

Check notice on line 42 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L42

Lists should be surrounded by blank lines

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Lists should be surrounded by blank lines

Suggested change
1. **Use Case 1**: Description of scenario
1. **Use Case 1**: Description of scenario

2. **Use Case 2**: Description of another scenario

## Implementation Considerations

### Wallet Compatibility
- [ ] MetaMask support needed

Check notice on line 48 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L48

Lists should be surrounded by blank lines

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Lists should be surrounded by blank lines

Suggested change
- [ ] MetaMask support needed
- [ ] MetaMask support needed

- [ ] Coinbase Wallet support needed
- [ ] Phantom Wallet support needed
- [ ] Cross-wallet compatibility required

### Technical Considerations

Check notice on line 53 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L53

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
### Technical Considerations
### Technical Considerations

- [ ] Breaking change required
- [ ] Backward compatibility can be maintained
- [ ] Documentation updates needed
- [ ] Example code needed

## Additional Context

Check notice on line 59 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L59

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Additional Context
## Additional Context

Add any other context, screenshots, links, or examples about the feature request here.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.
## Related Issues

Check notice on line 62 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L62

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Related Issues
## Related Issues

- Related to #(issue number)

Check notice on line 63 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L63

Lists should be surrounded by blank lines

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Lists should be surrounded by blank lines

Suggested change
- Related to #(issue number)
- Related to #(issue number)

- Depends on #(issue number)

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
## Priority

Check notice on line 66 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L66

Expected: 1; Actual: 0; Below

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Expected: 1; Actual: 0; Below

Suggested change
## Priority
## Priority

How important is this feature to you?
- [ ] Nice to have

Check notice on line 68 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L68

Lists should be surrounded by blank lines

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Lists should be surrounded by blank lines

Suggested change
- [ ] Nice to have
- [ ] Nice to have

- [ ] Important for my use case
- [ ] Critical for my project

**Additional context**
Add any other context or screenshots about the feature request here.
## Implementation Willingness
- [ ] I would like to implement this feature myself

Check notice on line 73 in .github/ISSUE_TEMPLATE/feature_request.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

.github/ISSUE_TEMPLATE/feature_request.md#L73

Lists should be surrounded by blank lines

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codacy has a fix for the issue: Lists should be surrounded by blank lines

Suggested change
- [ ] I would like to implement this feature myself
- [ ] I would like to implement this feature myself

- [ ] I can help with implementation
- [ ] I need the maintainers to implement this
- [ ] I can provide testing and feedback
6 changes: 6 additions & 0 deletions renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:recommended"
]
}
Loading