GOVERNANCE.md

   1 ## Khronos Group Vulkan-Tools Repository Management
   2
   3 # **Open Source Project \96 Objectives**
   4
   5 * Assist Vulkan Users
   6   - The goal is for tool and utility behavior to assist in the development of vulkan applications.
   7     - [Core Specification](https://www.khronos.org/registry/vulkan/specs/1.0/html/vkspec.html)
   8     - [Header Files](https://www.khronos.org/registry/vulkan/#headers)
   9     - [SDK Resources](https://vulkan.lunarg.com)
  10 * ISV Enablement
  11   - Updates of tools and utilities should be available in a timely fashion
  12   - Every effort will be made to be responsive to ISV issues
  13 * Cross Platform Compatibility
  14   - Google and LunarG collaboration:
  15     - Google: Monitor for Android
  16     - LunarG: Monitor for desktop (Windows, Linux, and MacOS)
  17     - Continuous Integration: HW test farms operated by Google and LunarG monitor various hardware/software platforms
  18 * Repo Quality
  19   - Repo remains in healthy state with all tests passing and good-quality, consistent codebase
  20   - Continuous Integration: Along with Github, HW test farms operated by Google and LunarG perform pre-commit cloud testing
  21 on pull-requests
  22
  23 # **Roles and Definitions**
  24 * Contributor, Commenter, User
  25   - Submitting contributions, creating issues, or using the contents of the repository
  26 * Approver
  27   - Experienced project members who have made significant technical contributions
  28   - Write control: Approve pull/merge requests (verify submissions vs. acceptance criteria)
  29 * Technical Project Leads
  30   - Lead the project in terms of versioning, quality assurance, and overarching objectives
  31   - Monitor github issues and drive timely resolution
  32   - Designate new approvers
  33   - Ensure project information such as the Readme, Contributing docs, wiki, etc., kept up-to-date
  34   - Act as a facilitator in resolving technical conflicts
  35   - Is a point-of-contact for project-related questions
  36
  37 The technical project leads for this repository are:
  38 * **Jeremy Kniager** [jeremyk@lunarg.com](mailto:jeremyk@lunarg.com)
  39
  40 # **Acceptance Criteria and Process**
  41   - All source code to include Khronos copyright and license (Apache 2.0).
  42     - Additional copyrights of contributors appended
  43   - Contributions are via pull requests
  44     - Project leads will assigning approvers to contributor pull requests
  45     - Approvers can self-assign their reviewers
  46     - For complex or invasive contributions, Project Leads may request approval from specific reviewers
  47     - At least one review approval is required to complete a pull request
  48     - The goal is to be responsive to contributors while ensuring acceptance criteria is met and to facilitate their submissions
  49     - Approval is dependent upon adherence to the guidelines in [CONTRIBUTING.md](CONTRIBUTING.md), and alignment with
  50 repository goals of maintainability, completeness, and quality
  51     - Conflicts or questions will ultimately be resolved by the project leads