Skip to content

Commit

Permalink
doc: Rename branch to main in documents (#88)
Browse files Browse the repository at this point in the history
  • Loading branch information
CsCherrYY authored Oct 25, 2021
1 parent 2202411 commit 4195083
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,25 @@ Before creating a new issue, please do a search to see if the issue or feature r
If you find your issue already exists, make relevant comments and add your reaction:
- 👍 - upvote
- 👎 - downvote

### Writing Good Bug Reports and Feature Requests
In order to let us know better about the issue, please make sure the following items are included with each issue:
- The repo link which you are indexing with
- Reproducible steps
- What you expected to see, versus what you actually saw
- Images, animations, or a link to a video showing the issue occurring

## Contributing Fixes
If you are interested in writing code to fix issues, please check the following content to see how to set up the developing environment.

### Overview
Generally speaking, the LSIF for Java uses several **visitors** to visit the AST([Abstract Syntax Tree](https://www.eclipse.org/articles/article.php?file=Article-JavaCodeManipulation_AST/index.html)) and dump the index according to the [LSIF Specification](https://github.com/Microsoft/language-server-protocol/blob/master/indexFormat/specification.md).
Generally speaking, the LSIF for Java uses several **visitors** to visit the AST([Abstract Syntax Tree](https://www.eclipse.org/articles/article.php?file=Article-JavaCodeManipulation_AST/index.html)) and dump the index according to the [LSIF Specification](https://github.com/Microsoft/language-server-protocol/blob/main/indexFormat/specification.md).

Major modules of the LSIF for Java are listed as follow:
- [AST visitors](https://github.com/Microsoft/lsif-java/tree/master/com.microsoft.java.lsif.core/src/com/microsoft/java/lsif/core/internal/visitors)
- [Language Server Index Format definitions](https://github.com/Microsoft/lsif-java/tree/master/com.microsoft.java.lsif.core/src/com/microsoft/java/lsif/core/internal/protocol)
- [Components and utilities for indexing](https://github.com/Microsoft/lsif-java/tree/master/com.microsoft.java.lsif.core/src/com/microsoft/java/lsif/core/internal/indexer)
- [Emitters to print out index information](https://github.com/Microsoft/lsif-java/tree/master/com.microsoft.java.lsif.core/src/com/microsoft/java/lsif/core/internal/emitter)
- [AST visitors](https://github.com/Microsoft/lsif-java/tree/main/com.microsoft.java.lsif.core/src/com/microsoft/java/lsif/core/internal/visitors)
- [Language Server Index Format definitions](https://github.com/Microsoft/lsif-java/tree/main/com.microsoft.java.lsif.core/src/com/microsoft/java/lsif/core/internal/protocol)
- [Components and utilities for indexing](https://github.com/Microsoft/lsif-java/tree/main/com.microsoft.java.lsif.core/src/com/microsoft/java/lsif/core/internal/indexer)
- [Emitters to print out index information](https://github.com/Microsoft/lsif-java/tree/main/com.microsoft.java.lsif.core/src/com/microsoft/java/lsif/core/internal/emitter)

### Setup
1. Fork and clone the repository: `git clone https://github.com/Microsoft/lsif-java.git`
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

The purpose of the Language Server Index Format (LSIF) is to define a standard format for language servers or other programming tools to dump their knowledge about a workspace. This dump can later be used to answer language server [LSP](https://microsoft.github.io/language-server-protocol/) requests for the same workspace without running the language server itself. Since much of the information would be invalidated by a change to the workspace, the dumped information typically excludes requests used when mutating a document. So, for example, the result of a code complete request is typically not part of such a dump.

A first draft specification can be found [here](https://github.com/Microsoft/language-server-protocol/blob/master/indexFormat/specification.md).
A first draft specification can be found [here](https://github.com/Microsoft/language-server-protocol/blob/main/indexFormat/specification.md).

## Quickstart

Expand Down

0 comments on commit 4195083

Please sign in to comment.