Skip to content

Commit

Permalink
Merge pull request #23 from watermarkhu/development
Browse files Browse the repository at this point in the history
contributing.md
  • Loading branch information
watermarkhu authored Feb 7, 2024
2 parents 32803ba + c49b5cf commit 6b3efd6
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 28 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
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
```
28 changes: 0 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,31 +69,3 @@ Alternatively, with the keyword argument `flatten` the element is displayed as a
- [VSCode Syntax Highlighting guide](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide)
- [vscode-textmate](https://github.com/microsoft/vscode-textmate)
- [Macromates texmate](https://macromates.com/textmate/manual/)


## Development

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
```

0 comments on commit 6b3efd6

Please sign in to comment.