-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from watermarkhu/development
contributing.md
- Loading branch information
Showing
2 changed files
with
23 additions
and
28 deletions.
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,23 @@ | ||
Install the repository after cloning with [poetry](https://python-poetry.org/), and setup [pre-commit](https://pre-commit.com/) such that code is linted and formatted with [Ruff](https://docs.astral.sh/ruff/). | ||
|
||
```bash | ||
> pip install poetry | ||
> cd textmate-grammar-python | ||
> poetry install | ||
> pre-commit install | ||
``` | ||
|
||
Run unit tests | ||
```bash | ||
> tox run | ||
``` | ||
|
||
Run static type checker | ||
```bash | ||
> tox run -e mypy | ||
``` | ||
|
||
Run regression testing against vscode-textmate (will install npm and required packages) | ||
```bash | ||
> tox run -e regression | ||
``` |
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