nordic-dev.net/vulkano
nordic-dev.net/vulkano
2
0
Fork 0
mirror of https://github.com/vulkano-rs/vulkano.git synced 2024-11-21 22:34:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

#1590 Changelog entries submission policy change

Browse Source
This commit is contained in:
Ilya Lakhin 2021-05-24 17:23:33 +07:00
parent 81ec4bff40
commit 728fab92d1
3 changed files with 31 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@ -1,4 +1,22 @@
* [ ] Added an entry to `CHANGELOG_VULKANO.md` or `CHANGELOG_VK_SYS.md` if knowledge of this change could be valuable to users
* [ ] Updated documentation to reflect any user-facing changes - in this repository
* [ ] Updated documentation to reflect any user-facing changes - PR to the [guide](https://github.com/vulkano-rs/vulkano-www) that fixes existing documentation invalidated by this PR.
* [ ] Ran `cargo fmt` on the changes
1. [ ] Describe in common words what is the purpose of this change, related
Github Issues, and highlight important implementation aspects.
2. [ ] Please put changelog entries **in the description of this Pull Request**
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
files(`CHANGELOG_VULKANO.md` and `CHANGELOG_VK_SYS.md`)
by maintainers right after the Pull Request merge.
* Entries for Vulkano changelog:
- `**Breaking** Breaking entry description.`
- `Non-breaking entry description.`...
* Entries for VkSys changelog:
- `Entry 1.`
- `Entry 2.`...
3. [ ] Run `cargo fmt` on the changes.
4. [ ] Make sure that the changes are covered by unit-tests.
5. [ ] Update documentation to reflect any user-facing changes - in this repository.

7
CHANGELOG_VULKANO.md
View File

@ -1,7 +1,10 @@
# Unreleased
<!--
Please add new changes at the bottom, preceded by a hyphen -.
Breaking changes should be listed first, before other changes, and should be preceded by - **Breaking**.
This file is maintained by the repository organization members. Please, do
not put changes into this files directly, they lead to frequent merging
conflicts. Instead put incoming changelog entries into the Pull Request
description. They will be transferred to this file right after the
Pull Request merge.
-->
- **Breaking** Vulkano-shaders now checks if the device supports the shader's SPIR-V version, when loading the shader.

7
README.md
View File

@ -95,15 +95,16 @@ community members.
**New Pull Requests are usually scheduled for review by the end of each week.**
The older PRs that already in review have priority over the new ones. We are trying to push
development forward as quick as possible, but the review process sometimes may take time,
development forward as quick as possible, but the review process sometimes takes time,
please be patient as the maintainers need time to check everything properly.
If something needs to get promoted urgently, please ping current Vulkano
maintainer([@Eliah-Lakhin](https://github.com/Eliah-Lakhin/)) in the PR's
or Issue's comments.
If your change adds, removes or modifies a trait or a function, please add an entry to the
changelog file(s) as part of your pull request.
If your change adds, removes or modifies a trait or a function, please
specify changelog entries **in the Pull Request description**(not in the changelog file directly).
They will be transferred to the changelog right after the PR merge.
Every PR must pass tests in order to be merged to `master`.