Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
skshetry authored Nov 23, 2024
1 parent ea415b4 commit 04d42e7
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,17 +67,21 @@ https://raw.githubusercontent.com/iterative/dvcyaml-schema/master/schema.json
The schema is generated using [Pydantic](https://docs.pydantic.dev/latest/) through the [gen.py](gen.py) script. You can make adjustments to the script as needed.

To manually generate the schema, run:
```
```console
$ ./gen.py schema.json
```

4. (Optional) Add [valid](examples/valid) and [invalid](examples/invalid) yaml examples.
5. Run tests using:
```
```console
$ pytest
```
6. Commit. `pre-commit` hook should run automatically and format/lint code, regenerate new schema, and run tests.
6. Git-add and then commit. `pre-commit` hook should run automatically and format/lint code, regenerate new schema, and run tests.
```console
$ git add -p
$ git commit -m "<message>"
```
If the hook makes additional changes, stage them and attempt the commit again.

7. Send us a pull request. 🤗
8. Send us a pull request. 🤗

0 comments on commit 04d42e7

Please sign in to comment.