Skip to content

Commit ba5cc75

Browse files
authored
Update README.md
1 parent 6c98885 commit ba5cc75

File tree

1 file changed

+44
-2
lines changed

1 file changed

+44
-2
lines changed

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,41 @@
1+
<img src="https://content.arduino.cc/website/Arduino_logo_teal.svg" height="100" align="right" />
2+
13
## Arduino Tools extension for VS Code
24

3-
VS Code extension for Arduino Tools, such as language features and debugger.
5+
VS Code extension for Arduino Tools, such as language features and debugger. This extension is part of the [Arduino IDE 2](https://github.com/arduino/arduino-ide).
6+
7+
## Bugs & Issues
8+
9+
High quality bug reports and feature requests are valuable contributions to the project.
10+
11+
Before reporting an issue search existing pull requests and issues to see if it was already reported. If you have additional information to provide about an existing issue, please comment there. You can use the Reactions feature if you only want to express support.
12+
13+
Qualities of an excellent report:
14+
15+
- The issue title should be descriptive. Vague titles make it difficult to understand the purpose of the issue, which might cause your issue to be overlooked.
16+
- Provide a full set of steps necessary to reproduce the issue. Demonstration code or commands should be complete and simplified to the minimum necessary to reproduce the issue.
17+
- Be responsive. We may need you to provide additional information in order to investigate and resolve the issue.
18+
- If you find a solution to your problem, please comment on your issue report with an explanation of how you were able to fix it and close the issue.
19+
20+
## How to contribute
21+
22+
Contributions are welcome! Here are all the way you can contribute to the project.
23+
24+
### Pull Requests
425

5-
### Quick Start
26+
To propose improvements or fix a bug, feel free to submit a PR.
27+
28+
### Pull request checklist
29+
30+
In order to ease code reviews and have your contributions merged faster, here is a list of items you can check before submitting a PR:
31+
32+
- Create small PRs that are narrowly focused on addressing a single concern.
33+
- Write tests for the code you wrote.
34+
- Open your PR against the master branch.
35+
- Maintain clean commit history and use meaningful commit messages. PRs with messy commit history are difficult to review and require a lot of work to be merged.
36+
- Your PR must pass all CI tests before we will merge it. If you're seeing an error and don't think it's your fault, it may not be! The reviewer will help you if there are test failures that seem not related to the change you are making.
37+
38+
## Build
639
To build the Arduino Tools VS Code extension (VSIX), execute:
740
```
841
yarn
@@ -14,3 +47,12 @@ Or from the [_Command Palette_](https://code.visualstudio.com/docs/editor/extens
1447

1548
You can also start the extension in debug mode.
1649
Open the `Debug` panel, and select the `Launch Arduino Tools – VS Code Extension` launch configuration.
50+
51+
## Donations
52+
53+
This open source code was written by the Arduino team and is maintained on a daily basis with the help of the community. We invest a considerable amount of time in development, testing and optimization. Please consider [donating](https://www.arduino.cc/en/donate/) or [sponsoring](https://github.com/sponsors/arduino) to support our work, as well as [buying original Arduino boards](https://store.arduino.cc/) which is the best way to make sure our effort can continue in the long term.
54+
55+
## License
56+
57+
The code contained in this repository is licensed under the terms of the Apache 2.0 license. If you have questions about licensing please contact us at [license@arduino.cc](mailto:license@arduino.cc).
58+

0 commit comments

Comments
 (0)