-
-
Notifications
You must be signed in to change notification settings - Fork 17
Update README before making the repository public #73
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 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 hidden or 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 |
---|---|---|
@@ -1,50 +1,29 @@ | ||
# Arduino Language Server | ||
|
||
**Arduino Language Server** is the the tool that powers the autocompletion of the new [Arduino IDE 2][arduino-ide-repo]. | ||
|
||
## Build | ||
|
||
To build the Arduino Language Server you need: | ||
|
||
- [Go][go-install] version 1.12 or later | ||
|
||
The project doesn't require `CGO` so it can be easily crosscompiled if necessary. To build for you machine just run: | ||
|
||
``` | ||
go build | ||
``` | ||
|
||
To run tests: | ||
|
||
``` | ||
go test -v ./... | ||
``` | ||
<img src="https://content.arduino.cc/website/Arduino_logo_teal.svg" height="100" align="right" /> | ||
|
||
## How to contribute | ||
# Arduino Language Server | ||
|
||
Contributions are welcome! Here are all the way you can contribute to the project. | ||
The **Arduino Language Server** is the tool that powers the autocompletion of the new [Arduino IDE 2][arduino-ide-repo]. It implements the standard [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) so it can be used with other IDEs as well. | ||
|
||
### Issue Reports | ||
## Bugs & Issues | ||
|
||
High quality bug reports and feature requests are valuable contributions to the project. | ||
|
||
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. | ||
|
||
Qualities of an excellent report | ||
Qualities of an excellent report: | ||
|
||
- 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. | ||
- 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. | ||
- Be responsive. We may need you to provide additional information in order to investigate and resolve the issue. | ||
- 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. | ||
|
||
### Pull Requests | ||
## How to contribute | ||
|
||
To propose improvements or fix a bug, feel free to submit a PR. | ||
Contributions are welcome! Here are all the way you can contribute to the project. | ||
|
||
### Legal requirements | ||
### Pull Requests | ||
|
||
Before we can accept your contributions you have to sign the Contributor License Agreement | ||
Pull request checklist | ||
To propose improvements or fix a bug, feel free to submit a PR. | ||
|
||
### Pull request checklist | ||
|
||
|
@@ -56,5 +35,32 @@ In order to ease code reviews and have your contributions merged faster, here is | |
- 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. | ||
- 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. | ||
|
||
## Build | ||
|
||
To build the Arduino Language Server you need: | ||
|
||
- [Go][go-install] version 1.12 or later | ||
|
||
The project doesn't require `CGO` so it can be easily crosscompiled if necessary. To build for you machine just run: | ||
|
||
``` | ||
go build | ||
``` | ||
|
||
To run tests: | ||
|
||
``` | ||
go test -v ./... | ||
``` | ||
|
||
## Donations | ||
|
||
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. | ||
|
||
## License | ||
|
||
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 [[email protected]](mailto:[email protected]). | ||
|
||
|
||
[arduino-ide-repo]: https://github.com/arduino/arduino-ide | ||
[go-install]: https://golang.org/doc/install |
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.
"ways"