diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..1ca8e35 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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 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 +A clear and concise description of what actually happened. + +## Environment Information +- **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 +```typescript +// Paste your configuration code here +const config = configure() + .withMetaMask() + // ... other configuration + .build(); +``` + +## 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 +```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 +If applicable, add screenshots to help explain your problem. + +## Additional Context Add any other context about the problem here. + +## Possible Solution +If you have suggestions on how to fix the bug, please describe them here. + +## Checklist +- [ ] 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 346da1a..0000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. -title: '' -labels: '' -assignees: joe10832 - ---- - - diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 2f7f350..dfa28a7 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -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 @@ -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) \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..ee1ff97 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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 +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) +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 +Describe any alternative solutions or features you've considered. + +## Use Cases +Describe specific use cases for this feature: +1. **Use Case 1**: Description of scenario +2. **Use Case 2**: Description of another scenario + +## Implementation Considerations + +### Wallet Compatibility +- [ ] MetaMask support needed +- [ ] Coinbase Wallet support needed +- [ ] Phantom Wallet support needed +- [ ] Cross-wallet compatibility required + +### Technical Considerations +- [ ] Breaking change required +- [ ] Backward compatibility can be maintained +- [ ] Documentation updates needed +- [ ] Example code needed + +## 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 +- 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 +How important is this feature to you? +- [ ] 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 +- [ ] I can help with implementation +- [ ] I need the maintainers to implement this +- [ ] I can provide testing and feedback \ No newline at end of file diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..5db72dd --- /dev/null +++ b/renovate.json @@ -0,0 +1,6 @@ +{ + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": [ + "config:recommended" + ] +}