Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/validate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .
pip install ".[validate]"

- name: Validate LSL definitions via jsonschema
run: |
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ __pycache__/
*.egg-info/
.ruff_cache/
.venv/

build
27 changes: 21 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,27 @@ Thank you for your interest in contributing to the LSL definitions repository! T

## How to Contribute

1. **Fork** this repository
2. **Create a branch** for your changes (`git checkout -b improve-documentation`)
3. **Make your changes** to `lsl_definitions.yaml`
4. **Test** that your YAML is valid
5. **Commit** your changes with a clear message
6. **Push** to your fork and **submit a pull request**
1. **Fork** this repository
2. **Create a branch** for your changes (`git checkout -b improve-documentation`)
3. **Make your changes** to `lsl_definitions.yaml`
4. **Test** that your YAML is valid (See [Running validation locally](#running-validation-locally))
5. **Commit** your changes with a clear message
6. **Push** to your fork and **submit a pull request**

## Running validation locally

Validation is done with python and the validate.py script you will need to setup a python virtual environment and install the dependancies

### Setup
```bash
python -m venv .venv
source .venv/bin/activate
pip install ".[validate]"
```
Now you should be able to run the validation script as specified in the `pyproject.toml`
```bash
validate-lsl-definitions-via-jsonschema
```

## Pull Request Guidelines

Expand Down
6 changes: 5 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ classifiers = [
]
requires-python = ">=3.8"
dependencies = [
"jsonschema",
"PyYAML",
"llsd"
]
Expand All @@ -39,6 +38,11 @@ Homepage = "https://github.com/secondlife/lsl-definitions"
Repository = "https://github.com/secondlife/lsl-definitions"
Issues = "https://github.com/secondlife/lsl-definitions/issues"

[project.optional-dependencies]
validate = [
"jsonschema",
]

[tool.setuptools]
py-modules = [
"gen_definitions",
Expand Down