From c082123f74c5e2d9564d92be687f49b6bb378908 Mon Sep 17 00:00:00 2001 From: makspll Date: Sun, 2 Mar 2025 11:17:35 +0000 Subject: [PATCH 1/3] add links to examples --- docs/src/Examples/introduction.md | 5 +++++ docs/src/SUMMARY.md | 4 ++++ 2 files changed, 9 insertions(+) create mode 100644 docs/src/Examples/introduction.md diff --git a/docs/src/Examples/introduction.md b/docs/src/Examples/introduction.md new file mode 100644 index 0000000000..2b19c503d5 --- /dev/null +++ b/docs/src/Examples/introduction.md @@ -0,0 +1,5 @@ +# Examples + +In the future we hope to embedd live WASM code examples into the documentation, for now the best source of examples scripts will be our regression test suite available in all supported languages in our [github repository](https://github.com/makspll/bevy_mod_scripting/tree/main/assets/tests). + +For rust examples see [this folder](https://github.com/makspll/bevy_mod_scripting/tree/main/examples). \ No newline at end of file diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index b9426418b9..2c5355b489 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -12,6 +12,10 @@ - [Script ID Mapping](./Summary/script-id-mapping.md) - [Script Systems](./ScriptSystems/introduction.md) +# Examples + +- [Examples] (./Examples/introduction.md) + # Scripting Reference - [Introduction](./ScriptingReference/introduction.md) From 36dd14e20b2d1a110c0c2dfdac594c511070ba40 Mon Sep 17 00:00:00 2001 From: makspll Date: Sun, 2 Mar 2025 11:21:41 +0000 Subject: [PATCH 2/3] typo --- docs/src/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 2c5355b489..1eb77e463b 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -14,7 +14,7 @@ # Examples -- [Examples] (./Examples/introduction.md) +- [Examples](./Examples/introduction.md) # Scripting Reference From 93fdff4e73b7e084c9259ce4d7836b2fca3048bf Mon Sep 17 00:00:00 2001 From: makspll Date: Sun, 2 Mar 2025 11:49:12 +0000 Subject: [PATCH 3/3] add pr template and tighten conventional scopes --- .github/pull_request_template.md | 25 +++++++++++++++++++++++++ .github/workflows/pr-titles.yml | 6 +++++- docs/src/Examples/introduction.md | 2 +- docs/src/SUMMARY.md | 3 --- 4 files changed, 31 insertions(+), 5 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..134edcc3f7 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,25 @@ +# Summary +- enter PR summary here +- what did you change +- why did you do it this way? +- Are there alternative ways we need to keep in mind? + +## Testing (Read & Delete Me) +- Did you write tests to cover new or modified behavior? +- These are not necessary, but very welcome +- I am always happy to receive any PR's, but adding tests makes it easier for me to merge them! + +## Conventional PR Titles (Read & Delete me) +- This crate uses `release-plz` to manage our deploys +- A CI check will verify your PR title to make sure it uses a valid conventional prefix like: + - `feat: {title}` - corresponds to `Added` heading in changelog, backwards compatibile changes + - `fix: {title}` - corresponds to `Fixed` heading in changelog, fixes bugs or bad behavior + - `chore: {title}` - + - `docs: {title}` + - `tests: {title}` +- Adding a `!` before the `:` will signify this is also a breaking change + - This sort of change will cause a `MAJOR` version bump. +- You can also use scopes to further detail the area your PR is changing i.e.: + - `feat(ladfile): add global types` + - `fix(ladfile_builder): fix globals not getting exported` + - `docs(bms): document weird vector behavior on MacOS` \ No newline at end of file diff --git a/.github/workflows/pr-titles.yml b/.github/workflows/pr-titles.yml index 9d08f74f92..1d3a99de4b 100644 --- a/.github/workflows/pr-titles.yml +++ b/.github/workflows/pr-titles.yml @@ -25,4 +25,8 @@ jobs: feat chore test - docs \ No newline at end of file + docs + scopes: | + ladfile + ladfile_builder + bms \ No newline at end of file diff --git a/docs/src/Examples/introduction.md b/docs/src/Examples/introduction.md index 2b19c503d5..face23b50b 100644 --- a/docs/src/Examples/introduction.md +++ b/docs/src/Examples/introduction.md @@ -1,5 +1,5 @@ # Examples -In the future we hope to embedd live WASM code examples into the documentation, for now the best source of examples scripts will be our regression test suite available in all supported languages in our [github repository](https://github.com/makspll/bevy_mod_scripting/tree/main/assets/tests). +In the future we hope to embedd live WASM code examples into the documentation, for now the best source of example scripts will be our regression test suite available in all supported languages in our [github repository](https://github.com/makspll/bevy_mod_scripting/tree/main/assets/tests). For rust examples see [this folder](https://github.com/makspll/bevy_mod_scripting/tree/main/examples). \ No newline at end of file diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 1eb77e463b..770dda6d42 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -11,9 +11,6 @@ - [Shared Contexts](./Summary/sharing-contexts-between-scripts.md) - [Script ID Mapping](./Summary/script-id-mapping.md) - [Script Systems](./ScriptSystems/introduction.md) - -# Examples - - [Examples](./Examples/introduction.md) # Scripting Reference