Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added instructions on how to contribute to the project
  • Loading branch information
EduardoFernandes1410 authored Nov 29, 2022
1 parent 7b28dcd commit c18273c
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,23 @@ ext install eolang.eo
```

You can also install it from [its page](https://marketplace.visualstudio.com/items?itemName=eolang.eo) at Visual Studio Marketplace.

## How to Contribute
Read the code documentation which can be found [here](https://www.objectionary.com/eo-vscode/)

Clone the repository. Install node modules with:
```bash
$ npm install
```

Download grammar file and generate ANTLR4 parser with:
```bash
$ npm run fetch-and-build-grammar
```

Make changes on a new branch and create a pull request. To avoid frustration, run:
```bash
$ npm run linter
$ npm run compile
```
before commiting.

0 comments on commit c18273c

Please sign in to comment.