Skip to content

Commit 9503d72

Browse files
authored
docs: add links to examples in the book (#338)
* add links to examples * typo * add pr template and tighten conventional scopes
1 parent 4279ebf commit 9503d72

File tree

4 files changed

+36
-1
lines changed

4 files changed

+36
-1
lines changed

.github/pull_request_template.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Summary
2+
- enter PR summary here
3+
- what did you change
4+
- why did you do it this way?
5+
- Are there alternative ways we need to keep in mind?
6+
7+
## Testing (Read & Delete Me)
8+
- Did you write tests to cover new or modified behavior?
9+
- These are not necessary, but very welcome
10+
- I am always happy to receive any PR's, but adding tests makes it easier for me to merge them!
11+
12+
## Conventional PR Titles (Read & Delete me)
13+
- This crate uses `release-plz` to manage our deploys
14+
- A CI check will verify your PR title to make sure it uses a valid conventional prefix like:
15+
- `feat: {title}` - corresponds to `Added` heading in changelog, backwards compatibile changes
16+
- `fix: {title}` - corresponds to `Fixed` heading in changelog, fixes bugs or bad behavior
17+
- `chore: {title}` -
18+
- `docs: {title}`
19+
- `tests: {title}`
20+
- Adding a `!` before the `:` will signify this is also a breaking change
21+
- This sort of change will cause a `MAJOR` version bump.
22+
- You can also use scopes to further detail the area your PR is changing i.e.:
23+
- `feat(ladfile): add global types`
24+
- `fix(ladfile_builder): fix globals not getting exported`
25+
- `docs(bms): document weird vector behavior on MacOS`

.github/workflows/pr-titles.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,8 @@ jobs:
2525
feat
2626
chore
2727
test
28-
docs
28+
docs
29+
scopes: |
30+
ladfile
31+
ladfile_builder
32+
bms

docs/src/Examples/introduction.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Examples
2+
3+
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).
4+
5+
For rust examples see [this folder](https://github.com/makspll/bevy_mod_scripting/tree/main/examples).

docs/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- [Shared Contexts](./Summary/sharing-contexts-between-scripts.md)
1212
- [Script ID Mapping](./Summary/script-id-mapping.md)
1313
- [Script Systems](./ScriptSystems/introduction.md)
14+
- [Examples](./Examples/introduction.md)
1415

1516
# Scripting Reference
1617

0 commit comments

Comments
 (0)