vulkano/.github/PULL_REQUEST_TEMPLATE.md
2021-05-24 17:25:11 +07:00

901 B

  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.