Skip to content

Commit 07a91b0

Browse files
author
Maxwell Voss
committed
feat: Add issue templates, PR template, and GitHub Discussions
1 parent ae5a619 commit 07a91b0

3 files changed

Lines changed: 61 additions & 19 deletions

File tree

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Describe the Bug
10+
A clear description of what the bug is.
11+
12+
## To Reproduce
13+
Steps to reproduce the behavior:
14+
1. Add the action to your workflow
15+
2. Configure with '...'
16+
3. Run on PR
17+
4. See error
18+
19+
## Expected Behavior
20+
What you expected to happen.
21+
22+
## Scanner Output
23+
```
24+
Paste the JSON output or error logs here
25+
```
26+
27+
## Environment
28+
- Runner OS: [e.g. ubuntu-latest]
29+
- Solidity Version: [e.g. 0.8.24]
30+
- Action Version: [e.g. v2.0.0]
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for the scanner
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem
10+
Describe the problem you'd like solved.
11+
12+
## Proposed Solution
13+
Describe your ideal solution.
14+
15+
## Alternatives Considered
16+
Any alternative solutions you've considered.
17+
18+
## Additional Context
19+
Any other context or screenshots.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,17 @@
11
## Description
2-
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
2+
Brief description of the changes.
33

4-
Fixes # (issue)
5-
6-
## Type of change
7-
- [ ] Bug fix (non-breaking change which fixes an issue)
8-
- [ ] New feature (non-breaking change which adds functionality)
9-
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
4+
## Type of Change
5+
- [ ] Bug fix (non-breaking change that fixes an issue)
6+
- [ ] New feature (non-breaking change that adds functionality)
7+
- [ ] New detection rule
108
- [ ] Documentation update
119

12-
## How Has This Been Tested?
13-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
14-
- [ ] Unit Tests (`pytest tests/`)
15-
- [ ] Linting (`flake8`)
16-
- [ ] Tested against a live smart contract
10+
## Testing
11+
- [ ] I have run `pytest tests/` and all tests pass
12+
- [ ] I have tested with a real Solidity contract
1713

18-
## Checklist:
19-
- [ ] My code follows the style guidelines of this project
20-
- [ ] I have performed a self-review of my own code
21-
- [ ] I have made corresponding changes to the documentation
22-
- [ ] My changes generate no new warnings
23-
- [ ] I have added tests that prove my fix is effective or that my feature works
24-
- [ ] New and existing unit tests pass locally with my changes
14+
## Checklist
15+
- [ ] My code follows the project's style guidelines
16+
- [ ] I have added tests for my changes
17+
- [ ] I have updated documentation if needed

0 commit comments

Comments
 (0)