Skip to content

Commit c004593

Browse files
committed
Add GitHub issue templates
1 parent 8d20d60 commit c004593

3 files changed

Lines changed: 157 additions & 0 deletions

File tree

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
1. Open Vim with '...'
16+
2. Edit Solidity file containing '...'
17+
3. Perform action '...'
18+
4. See error/unexpected behavior
19+
20+
## Expected Behavior
21+
22+
A clear description of what you expected to happen.
23+
24+
## Actual Behavior
25+
26+
What actually happened instead.
27+
28+
## Minimal Solidity Code Example
29+
30+
```solidity
31+
// Minimal code that reproduces the issue
32+
contract Example {
33+
// ...
34+
}
35+
```
36+
37+
## Environment
38+
39+
- **Vim version**: (output of `vim --version`)
40+
- **OS**: (e.g., Ubuntu 22.04, macOS 14.0, Windows 11)
41+
- **Terminal**: (e.g., iTerm2, Windows Terminal, GNOME Terminal)
42+
- **vim-solidity version/commit**: (e.g., v0.8.0 or commit hash)
43+
- **Solidity version**: (if relevant, e.g., 0.8.24)
44+
45+
## Additional Context
46+
47+
Add any other context about the problem here, such as:
48+
- Does it happen with a minimal vimrc?
49+
- Related Vim plugins that might interact?
50+
- Screenshots if applicable
51+
52+
## Checklist
53+
54+
- [ ] I have searched existing issues for duplicates
55+
- [ ] I have tested with a minimal vimrc (`vim -Nu test/vimrc`)
56+
- [ ] I have provided a minimal code example
57+
- [ ] I have included my environment details
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
A clear and concise description of the feature you'd like to see.
12+
13+
## Motivation / Use Case
14+
15+
Why is this feature useful? What problem does it solve?
16+
17+
## Proposed Solution
18+
19+
How would you like this feature to work? Be as specific as possible.
20+
21+
```vim
22+
" Example configuration or usage
23+
```
24+
25+
```solidity
26+
// Example Solidity code if applicable
27+
```
28+
29+
## Alternatives Considered
30+
31+
What other approaches or workarounds have you considered?
32+
33+
## Compatibility
34+
35+
- Is this feature specific to a Solidity version? (e.g., 0.8.x only)
36+
- Should it work in both Vim and Neovim?
37+
- Does it depend on external tools? (e.g., solc, forge)
38+
39+
## Scope
40+
41+
- [ ] Syntax highlighting
42+
- [ ] Indentation
43+
- [ ] Code folding
44+
- [ ] File type detection
45+
- [ ] Toolchain integration (compiler, formatter)
46+
- [ ] Documentation
47+
- [ ] Other (please specify)
48+
49+
## Additional Context
50+
51+
Add any other context, mockups, screenshots, or examples about the feature request here.
52+
53+
## Checklist
54+
55+
- [ ] I have searched existing issues for similar requests
56+
- [ ] I have checked the [roadmap/plan](link-to-plan-if-available)
57+
- [ ] This feature aligns with pure Vim compatibility (no Neovim-only features)

.github/ISSUE_TEMPLATE/question.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Question
3+
about: Ask a question about using vim-solidity
4+
title: '[QUESTION] '
5+
labels: question
6+
assignees: ''
7+
---
8+
9+
## Question
10+
11+
What would you like to know about vim-solidity?
12+
13+
## Context
14+
15+
Provide context about what you're trying to accomplish:
16+
17+
- What are you trying to do?
18+
- What have you already tried?
19+
- What's not working as expected?
20+
21+
## Configuration
22+
23+
If relevant, share your Vim configuration:
24+
25+
```vim
26+
" Relevant parts of your .vimrc
27+
```
28+
29+
## Environment
30+
31+
- **Vim version**: (output of `vim --version`)
32+
- **vim-solidity version**: (e.g., v0.8.0 or commit hash)
33+
34+
## Additional Information
35+
36+
Any other details that might be helpful.
37+
38+
---
39+
40+
**Note**: For general Vim or Solidity questions unrelated to this plugin, you may find better help at:
41+
- [Vi and Vim Stack Exchange](https://vi.stackexchange.com/)
42+
- [Ethereum Stack Exchange](https://ethereum.stackexchange.com/)
43+
- [Solidity Documentation](https://docs.soliditylang.org/)

0 commit comments

Comments
 (0)