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 new file mode 100644 index 0000000000..face23b50b --- /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 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 b9426418b9..770dda6d42 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -11,6 +11,7 @@ - [Shared Contexts](./Summary/sharing-contexts-between-scripts.md) - [Script ID Mapping](./Summary/script-id-mapping.md) - [Script Systems](./ScriptSystems/introduction.md) +- [Examples](./Examples/introduction.md) # Scripting Reference