Skip to content

Commit a58c7b7

Browse files
authored
add contributing.md and issue templates (#34)
* add contribution guidelines and update the readme * add bug report template * add feature request template
1 parent 3fe8e01 commit a58c7b7

File tree

5 files changed

+66
-8
lines changed

5 files changed

+66
-8
lines changed
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Bug report
3+
about: Bug report
4+
labels: bug
5+
---
6+
7+
- VS Code Version:
8+
- Extension (vscode-vba) Version:
9+
10+
**What did you do?**
11+
12+
**Actual behaviour**
13+
14+
**Expected behavior**
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea
4+
---
5+
6+
**What problem does the feature solve?**
7+
8+
**Preferred Solution**
9+
What should happen? How might the feature work?
10+
11+
**Possible alternatives**
12+
Have you considered any alternatives? Please describe them here.

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Contributing
2+
Thank you for taking the time to contribute :tada:
3+
4+
Before making changes, please discuss them in an issue.
5+
6+
## Testing
7+
Every PR should contain a test case that covers the added feature or bug fix.
8+
This prevents regressions and makes reviewing the changes easier by proofing correct functionality.
9+
10+
Tests for the language grammar providing the syntax highlighting are in [`syntaxes/tests`](syntaxes/tests/).
11+
They can be run with the following command:
12+
```
13+
npm run test
14+
```
15+
16+
## Repository Setup
17+
Create and clone a fork of https://github.com/serkonda7/vscode-vba.
18+
Inside the cloned directory run `npm install`.
19+
20+
## Compilation and Linting
21+
Currently there are no features that rely on typescript.
22+
Thus there is no need to compile or lint the code during development.
23+
24+
## Packaging
25+
Installation packages (.vsix) can be generated by the following command:
26+
```
27+
npm run package
28+
```

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
1-
# Visual Basic language support for VS Code
2-
1+
# Visual Basic for Applications support for VS Code
32
![GitHub Workflow Status][workflow-status]
43
[![Version][version-badge]][marketplace-url]
54
[![Installs][installs-badge]][marketplace-url]
65

6+
Adds VBA language support to Visiual Studio Code.
7+
The only feature until now is syntax highlighting.
8+
79
## Installation
8-
Launch the quick open view (`ctrl`+`P`) and run the following command.
9-
```
10-
ext install serkonda7.vscode-vba
11-
```
10+
Launch the command palette (`ctrl+P`) and run `ext install serkonda7.vscode-vba`.
11+
12+
## Contributing
13+
Any contributions like bug reports, code, tests or documentation are appreciated!
14+
For details see [CONTRIBUTING.md](CONTRIBUTING.md).
15+
1216
## License
1317
Core extension parts are covered by the [MIT license](LICENSE.md).<br>
14-
The icon ,originally created by [Roberto Huertas][icon-source] with the text added by Lukas Neubert, is licensed under [CC BY 4.0][cc-by-4].
18+
The icon, originally created by [Roberto Huertas][icon-source] with the text added by Lukas Neubert, is licensed under [CC BY 4.0][cc-by-4].
1519

1620
<!-- links -->
1721
[workflow-status]: https://img.shields.io/github/workflow/status/serkonda7/vscode-vba/CI

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "vscode-vba",
33
"displayName": "VBA",
4-
"description": "Visual Basic language support for VS Code.",
4+
"description": "Visual Basic for Applications support for VS Code.",
55
"icon": "images/icon_256x256.png",
66
"version": "0.1.4-dev",
77
"license": "MIT",

0 commit comments

Comments
 (0)