2022-09-24 08:15:14 +00:00
|
|
|
1. [ ] Update documentation to reflect any user-facing changes - in this repository.
|
|
|
|
|
|
|
|
|
|
2. [ ] Make sure that the changes are covered by unit-tests.
|
|
|
|
|
|
2024-01-05 08:08:36 +00:00
|
|
|
3. [ ] Run `cargo clippy` on the changes.
|
2021-05-24 10:23:33 +00:00
|
|
|
|
2024-01-05 08:08:36 +00:00
|
|
|
4. [ ] Run `cargo +nightly fmt` on the changes.
|
|
|
|
|
|
|
|
|
|
5. [ ] Please put changelog entries **in the description of this Pull Request**
|
2021-05-24 10:23:33 +00:00
|
|
|
if knowledge of this change could be valuable to users. No need to put the
|
|
|
|
|
entries to the changelog directly, they will be transferred to the changelog
|
2022-09-24 08:15:14 +00:00
|
|
|
file by maintainers right after the Pull Request merge.
|
2024-01-03 08:45:14 +00:00
|
|
|
|
2022-09-24 08:15:14 +00:00
|
|
|
Please remove any items from the template below that are not applicable.
|
2021-05-24 10:23:33 +00:00
|
|
|
|
2024-01-05 08:08:36 +00:00
|
|
|
6. [ ] Describe in common words what is the purpose of this change, related
|
2022-09-24 08:15:14 +00:00
|
|
|
Github Issues, and highlight important implementation aspects.
|
2021-05-24 10:23:33 +00:00
|
|
|
|
2022-09-24 08:15:14 +00:00
|
|
|
Changelog:
|
|
|
|
|
```markdown
|
|
|
|
|
### Public dependency updates
|
|
|
|
|
- [some_crate](https://crates.io/crates/some_crate) 1.0
|
2024-01-03 08:45:14 +00:00
|
|
|
|
2022-09-24 08:15:14 +00:00
|
|
|
### Breaking changes
|
|
|
|
|
Changes to `Foo`:
|
|
|
|
|
- Renamed to `Bar`.
|
2021-05-24 10:23:33 +00:00
|
|
|
|
2022-09-24 08:15:14 +00:00
|
|
|
### Additions
|
|
|
|
|
- Support for the `khr_foobar` extension.
|
2021-05-24 10:23:33 +00:00
|
|
|
|
2022-09-24 08:15:14 +00:00
|
|
|
### Bugs fixed
|
|
|
|
|
- `bar` panics when calling `foo`.
|
|
|
|
|
````
|
