From cb198a483096669f2752defe09312675b77476a4 Mon Sep 17 00:00:00 2001 From: Project Mu Uefibot <45776386+uefibot@users.noreply.github.com> Date: Wed, 30 Nov 2022 08:23:35 -0800 Subject: [PATCH] Repo File Sync: Synced file(s) with microsoft/mu_devops (#18) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Synced local file(s) with [microsoft/mu_devops](https://github.com/microsoft/mu_devops). 🤖: View the [Repo File Sync Configuration File](https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml) to see how files are synced. --- This PR was created automatically by the [repo-file-sync-action](https://github.com/BetaHuhn/repo-file-sync-action) workflow run [#3578665266](https://github.com/microsoft/mu_devops/actions/runs/3578665266) Signed-off-by: Project Mu UEFI Bot --- .github/ISSUE_TEMPLATE/bug_report.yml | 143 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 20 +++ .../ISSUE_TEMPLATE/documentation_request.yml | 53 +++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 96 ++++++++++++ .github/dependabot.yml | 48 ++++++ .github/pull_request_template.md | 20 +++ .github/workflows/label-issues.yml | 34 +++++ .github/workflows/label-issues/file-paths.yml | 12 ++ .../label-issues/regex-pull-requests.yml | 24 +++ .github/workflows/label-sync.yml | 6 + .github/workflows/stale.yml | 6 + .markdownlint.yaml | 35 +++-- CONTRIBUTING.md | 51 +++++++ 13 files changed, 534 insertions(+), 14 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_request.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/dependabot.yml create mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/label-issues.yml create mode 100644 .github/workflows/label-issues/file-paths.yml create mode 100644 .github/workflows/label-issues/regex-pull-requests.yml create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..12b5b4b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,143 @@ +# Project Mu GitHub Bug Report Template +# +# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there +# instead of the file in this repo. +# +# - Mu DevOps Repo: https://github.com/microsoft/mu_devops +# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +name: 🐛 Bug Report +description: File a bug report +title: "[Bug]: " +labels: ["type:bug", "state:needs-triage"] + +body: + - type: markdown + attributes: + value: | + 👋 Thanks for taking the time to fill out this bug report! + + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched existing issues + required: true + + - type: textarea + id: current_behavior + attributes: + label: Current Behavior + description: A concise description of the bug that you're experiencing. + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + + - type: textarea + id: steps_to_reproduce + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + <example> + 1. In this environment... + 2. With this config... + 3. Boot to '...' + 4. Change option '...' + 4. See error... + validations: + required: true + + - type: textarea + id: build_environment + attributes: + label: Build Environment + description: | + examples: + - **OS**: Ubuntu 20.04 or Windows 11... + - **Tool Chain**: GCC5 or VS2022 or CLANGPDB... + - **Targets Impacted**: RELEASE, DEBUG, NO-TARGET, NOOPT... + value: | + - OS(s): + - Tool Chain(s): + - Targets Impacted: + render: markdown + validations: + required: true + + - type: textarea + id: version_info + attributes: + label: Version Information + description: What version of this repo reproduces the problem? + placeholder: | + Commit: <SHA> + -or- + Tag: <Tag> + render: text + validations: + required: true + + - type: markdown + attributes: + value: | + **Urgency Key** + - 🟢 **Low** + - A minor change with little to no important functional impact + - It is not important to fix this in a specific time frame + - 🟡 **Medium** + - An important change with a functional impact + - Will be prioritized above *low* issues in the normal course of development + - 🔥 **High** + - A critical change that has a significant functional impact + - Must be fixed immediately + + - type: dropdown + id: urgency + attributes: + label: Urgency + description: How urgent is it to fix this bug? + multiple: false + options: + - Low + - Medium + - High + validations: + required: true + + - type: dropdown + id: fix_owner + attributes: + label: Are you going to fix this? + description: Indicate if you are going to fix this or requesting someone else fix it. + multiple: false + options: + - I will fix it + - Someone else needs to fix it + validations: + required: true + + - type: textarea + id: anything_else + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering. + + Serial debug logs and/or debugger logs are especially helpful! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..f9b067c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,20 @@ +# Project Mu GitHub Issue Configuration File +# +# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there +# instead of the file in this repo. +# +# - Mu DevOps Repo: https://github.com/microsoft/mu_devops +# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +contact_links: + - name: 📃 Project Mu Documentation + url: https://microsoft.github.io/mu/ + about: Goals, principles, repo layout, build instructions, and more. + + - name: 🔐 Security Reporting Policy + url: https://github.com/microsoft/.github/blob/main/SECURITY.md + about: A special process is used to report security vulnerabilities. diff --git a/.github/ISSUE_TEMPLATE/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml new file mode 100644 index 0000000..d8ed7cf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_request.yml @@ -0,0 +1,53 @@ +# Project Mu GitHub Documentation Request Template +# +# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there +# instead of the file in this repo. +# +# - Mu DevOps Repo: https://github.com/microsoft/mu_devops +# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +name: 📖 Documentation Request +description: Request a documentation change +title: "[Documentation]: <title>" +labels: ["type:documentation", "state:needs-triage"] + +body: + - type: markdown + attributes: + value: | + 👋 Thanks for taking the time to help us improve our documentation! + + - type: textarea + id: request_description + attributes: + label: Request Description + description: A clear and concise description of what needs to change. + validations: + required: true + + - type: dropdown + id: request_owner + attributes: + label: Are you going to make the change? + description: Indicate if you are going to make this change or requesting someone else make it. + multiple: false + options: + - I will make the change + - Someone else needs to make the change + validations: + required: true + + - type: textarea + id: anything_else + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the request. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..28bf884 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,96 @@ +# Project Mu GitHub Feature Request Template +# +# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there +# instead of the file in this repo. +# +# - Mu DevOps Repo: https://github.com/microsoft/mu_devops +# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +name: 🚀 Feature Request +description: Request a feature change +title: "[Feature]: <title>" +labels: ["type:feature-request", "state:needs-triage"] + +body: + - type: markdown + attributes: + value: | + 👋 Thanks for taking the time to help us improve our features! + + - type: textarea + id: feature_overview + attributes: + label: Feature Overview + description: Provide a high-level summary of your feature request. + validations: + required: true + + - type: textarea + id: solution_overview + attributes: + label: Solution Overview + description: Give a clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives_considered + attributes: + label: Alternatives Considered + description: Describe alternatives you've considered. + validations: + required: false + + - type: markdown + attributes: + value: | + **Urgency Key** + - 🟢 **Low** + - A minor enhancement + - It is not important to address this request in a specific time frame + - 🟡 **Medium** + - An important enhancement + - Will be prioritized above *low* requests in the normal course of development + - 🔥 **High** + - A critical enhancement with significant value + - Should be prioritized above *low* and *medium* requests + + - type: dropdown + id: urgency + attributes: + label: Urgency + description: How urgent is it to resolve this feature request? + multiple: false + options: + - Low + - Medium + - High + validations: + required: true + + - type: dropdown + id: request_owner + attributes: + label: Are you going to implement the feature request? + description: Indicate if you are going to do the work to close this feature request. + multiple: false + options: + - I will implement the feature + - Someone else needs to implement the feature + validations: + required: true + + - type: textarea + id: anything_else + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the feature you are requesting. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..bfd0adc --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,48 @@ +## @file +# Dependabot configuration file to enable GitHub services for managing and updating +# dependencies. +# +# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there +# instead of the file in this repo. +# +# This dependabot file is limited to syncing the following type of dependencies. Other files +# are already available in Mu DevOps to sync other dependency types. +# - GitHub Actions (`github-actions`) +# - Python PIP Modules (`pip`) +# +# - Mu DevOps Repo: https://github.com/microsoft/mu_devops +# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +# Please see the documentation for all dependabot configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates +## + +version: 2 + +updates: + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "weekly" + day: "monday" + commit-message: + prefix: "GitHub Action" + labels: + - "type:dependencies" + reviewers: + - "microsoft/project-mu-dependency-reviewers" + + - package-ecosystem: "pip" + directory: "/" + schedule: + interval: "daily" + commit-message: + prefix: "pip" + labels: + - "language:python" + - "type:dependencies" + reviewers: + - "microsoft/project-mu-dependency-reviewers" diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..1004868 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,20 @@ +## Description + +<_Please include a description of the change and why this change was made._> + +For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. +_(you can also check items in the GitHub UI)_ + +- [ ] Impacts functionality? +- [ ] Impacts security? +- [ ] Breaking change? +- [ ] Includes tests? +- [ ] Includes documentation? + +## How This Was Tested + +<_Please describe the test(s) that were run to verify the changes._> + +## Integration Instructions + +<_Describe how these changes should be integrated. Use N/A if nothing is required._> diff --git a/.github/workflows/label-issues.yml b/.github/workflows/label-issues.yml new file mode 100644 index 0000000..2ad0297 --- /dev/null +++ b/.github/workflows/label-issues.yml @@ -0,0 +1,34 @@ +# This workflow automatically applies labels to GitHub issues and pull requests based on the +# file paths in a pull request or content in the body of an issue or pull request. +# +# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there +# instead of the file in this repo. +# +# NOTE: This file uses a reusable workflow. Do not make changes to the file that should be made +# in the common/reusable workflow. +# +# - Mu DevOps Repo: https://github.com/microsoft/mu_devops +# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +name: Apply Issue and PR Labels + +on: + issues: + types: + - edited + - opened + pull_request_target: + types: + - edited + - opened + - reopened + - synchronize + workflow_dispatch: + +jobs: + apply: + uses: microsoft/mu_devops/.github/workflows/Labeler.yml@main diff --git a/.github/workflows/label-issues/file-paths.yml b/.github/workflows/label-issues/file-paths.yml new file mode 100644 index 0000000..5cd3a7b --- /dev/null +++ b/.github/workflows/label-issues/file-paths.yml @@ -0,0 +1,12 @@ +# Specifies labels to apply to issues and pull requests based on file path patterns in Project Mu repositories. +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +# For more information, see: +# https://github.com/actions/labeler + +# Maintenance: Keep labels organized in ascending alphabetical order - easier to scan, identify duplicates, etc. + +language:python: + - '**/*.py' diff --git a/.github/workflows/label-issues/regex-pull-requests.yml b/.github/workflows/label-issues/regex-pull-requests.yml new file mode 100644 index 0000000..175d3c3 --- /dev/null +++ b/.github/workflows/label-issues/regex-pull-requests.yml @@ -0,0 +1,24 @@ +# Specifies labels to apply to pull requests in Project Mu repositories based on regular expressions. +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# +# For more information, see: +# https://github.com/github/issue-labeler + +# Maintenance: Keep labels organized in ascending alphabetical order - easier to scan, identify duplicates, etc. + +impact:breaking-change: + - '\s*-\s*\[\s*[x|X]\s*\] Breaking change\?' + +impact:non-functional: + - '\s*-\s*\[\s*[x|X]\s*\] Impacts functionality\?' + +impact:security: + - '\s*-\s*\[\s*[x|X]\s*\] Impacts security\?' + +impact:testing: + - '\s*-\s*\[\s*[x|X]\s*\] Includes tests\?' + +type:documentation: + - '\s*-\s*\[\s*[x|X]\s*\] Includes documentation\?' diff --git a/.github/workflows/label-sync.yml b/.github/workflows/label-sync.yml index e65acc4..e7b493e 100644 --- a/.github/workflows/label-sync.yml +++ b/.github/workflows/label-sync.yml @@ -3,6 +3,12 @@ # All repos should sync at the same time. # '0 0,12 * * *'' # +# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there +# instead of the file in this repo. +# +# - Mu DevOps Repo: https://github.com/microsoft/mu_devops +# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml +# # Copyright (c) Microsoft Corporation. # SPDX-License-Identifier: BSD-2-Clause-Patent # diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index ce96011..043c26b 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -1,5 +1,11 @@ # This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time. # +# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there +# instead of the file in this repo. +# +# - Mu DevOps Repo: https://github.com/microsoft/mu_devops +# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml +# # Copyright (c) Microsoft Corporation. # SPDX-License-Identifier: BSD-2-Clause-Patent # diff --git a/.markdownlint.yaml b/.markdownlint.yaml index c3e4b83..d9ec238 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,14 +1,21 @@ -## @file -# markdownlint configuration -# -# Copyright (c) Microsoft Corporation -# SPDX-License-Identifier: BSD-2-Clause-Patent -## - -# Rules can be found here: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md -# Config info: https://github.com/DavidAnson/markdownlint#configuration -{ - "default": true, - "MD013": {"line_length": 120, "code_blocks": false, "tables": false}, - "MD033": {"allowed_elements": ["br"]} -} \ No newline at end of file +## @file +# markdownlint configuration +# +# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there +# instead of the file in this repo. +# +# - Mu DevOps Repo: https://github.com/microsoft/mu_devops +# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +## + +# Rules can be found here: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md +# Config info: https://github.com/DavidAnson/markdownlint#configuration + +{ + "default": true, + "MD013": {"line_length": 120, "code_blocks": false, "tables": false}, + "MD033": {"allowed_elements": ["br"]} +} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b7df7bf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# Contributing to Project Mu + +Welcome, and thank you for your interest in contributing to Project Mu! + +There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a +high-level overview of how you can get involved. + +If this is your first time working with Project Mu, please keep in mind that many project details are maintained in +the [Project Mu Documentation](https://microsoft.github.io/mu/). + +## Asking Questions + +Have a question? Rather than opening an issue, please post your question under the `Q&A` category in the `Discussions` +section of the relevant Project Mu GitHub repo. + +## Reporting Issues + +Every Project Mu repo has an `Issues` section. Bug reports, feature requests, and documentation requests can all be +submitted in the issues section. + +### Identify Where to Report + +Project Mu is distributed across multiple repositories. Use features such as issues and discussions in the repository +most relevant to the topic. + +Although we prefer items to be filed in the most relevant repo, if you're unsure which repo is most relevant, the item +can be filed in the [Project Mu Documentation Repo](https://github.com/microsoft/mu) and we will review the request and +move it to the relevant repo if necessary. + +### Look For an Existing Issue + +Before you create a new issue, please do a search in the issues section of the relevant repo to see if the issue or +feature request has already been filed. + +If you find your issue already exists, make relevant comments and add your +[reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Use a reaction in place +of a "+1" comment: + +* 👍 - upvote +* 👎 - downvote + +If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below. + +### Follow Your Issue + +Please continue to follow your request after it is submitted to assist with any additional information that might be +requested. + +## Thank You + +Thank you for your interest in Project Mu and taking the time to contribute!