This repository has been archived by the owner on Oct 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 233
added contribution guidelines #665
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# Contributing to VS Code extension for Arduino | ||
|
||
Welcome, and thank you for your interest in contributing to the VS Code extension for Arduino! | ||
|
||
There are many ways that you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved. | ||
|
||
## Contributing Fixes | ||
|
||
If you are interested in writing code to fix issues, first look at the issues with the [help-wanted](https://github.com/Microsoft/vscode-arduino/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) label. They should have the context and code pointers needed to get started. If not, then feel free to ask for some, and we will be happy to provide any guidance you need. | ||
|
||
|
||
|
||
## Reporting Issues | ||
|
||
Have you identified a reproducible problem? Have a feature request? We want to hear about it! Here's how you can make reporting your issue as effective as possible. | ||
|
||
### Look For an Existing Issue | ||
|
||
Before you create a new issue, please do a search in [open issues](https://github.com/Microsoft/vscode-arduino/issues) to see if the issue or feature request has already been filed. | ||
|
||
Be sure to scan through the [most popular](https://github.com/Microsoft/vscode-arduino/issues?q=is%3Aopen+is%3Aissue+sort%3Areactions-%2B1-desc) issues. | ||
|
||
If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place of a "+1" comment: | ||
|
||
* 👍 - upvote | ||
* 👎 - downvote | ||
|
||
Subscribe to such issues so that you are kept up to date about the progress. | ||
|
||
If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below. | ||
|
||
### Writing Good Bug Reports and Feature Requests | ||
|
||
File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue. | ||
|
||
Do not add your issue as a comment to an existing issue unless it's for the identical input. Many issues look similar, but have different causes. | ||
|
||
The more information you can provide, the more likely someone will be successful reproducing the issue and finding a fix. | ||
|
||
Please include the following with each issue: | ||
|
||
* Version of VS Code and this extension | ||
|
||
* OS/Platform you are working on | ||
|
||
* Reproducible steps (1... 2... 3...) that cause the issue | ||
|
||
* What you expected to see, versus what you actually saw | ||
|
||
* Images, animations, or a link to a video showing the issue occurring | ||
|
||
* A code snippet that demonstrates the issue or a link to a code repository the developers can easily pull down to recreate the issue locally | ||
|
||
* **Note:** Because the developers need to copy and paste the code snippet, including a code snippet as a media file (i.e. .gif) is not sufficient. | ||
|
||
* Errors from the Dev Tools Console (open from the menu: Help > Toggle Developer Tools -> Console) | ||
|
||
### Final Checklist | ||
|
||
Please remember to do the following: | ||
|
||
* [ ] Search the issue repository to ensure your report is a new issue | ||
|
||
* [ ] Simplify your code around the issue to better isolate the problem | ||
|
||
Don't feel bad if others can't reproduce the issue right away. They will simply ask for more information! | ||
|
||
### Follow Your Issue | ||
|
||
Once submitted, your report will go into the [issue tracking](https://github.com/Microsoft/vscode/wiki/Issue-Tracking) workflow. Be sure to understand what will happen next, so you know what to expect, and how to continue to assist throughout the process. | ||
|
||
## Automated Issue Management | ||
|
||
We use a bot to help us manage issues. This bot currently: | ||
|
||
* Automatically closes any issue marked `needs-more-info` if there has been no response in past 7 days. | ||
* Automatically locks issues 45 days after they are closed. | ||
|
||
If you believe the bot got something wrong, please open a new issue and let us know. | ||
|
||
# Thank You! | ||
|
||
Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove this section, as we don't want have this kind of bot to close bugs :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool! removed that part!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks a lot !