From 1804287da7dfa2f4e74feb2ea697c8520ed41f1f Mon Sep 17 00:00:00 2001 From: Bryan Apellanes <63638027+bryanapellanes-okta@users.noreply.github.com> Date: Fri, 17 Dec 2021 09:35:57 -0800 Subject: [PATCH] OKTA-448513: update pr templates (#85) --- .github/ISSUE_TEMPLATE/bug_report.md | 39 ---------- .github/ISSUE_TEMPLATE/bug_report.yml | 84 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 4 ++ .github/ISSUE_TEMPLATE/feature_request.md | 30 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 34 +++++++++ .github/SECURITY.md | 4 ++ .github/pull_request_template.md | 62 ++++++++-------- 7 files changed, 159 insertions(+), 98 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/SECURITY.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index d29e2e5b..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Bug report -about: Report a bug - ---- - - - - -## Current behavior - - - -## Expected behavior - - - -## Minimal reproduction of the problem with instructions - - - -## Environment - -- OS: -- Browser: - -- .Net Framework: - -- Other: - diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..16e90a84 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,84 @@ +name: Bug Report +description: Report a bug you encountered with the Okta Xamarin SDK +labels: [ bug ] +body: + - type: textarea + id: problemDescription + attributes: + label: Describe the bug? + description: | + Please be as detailed as possible. This will help us address the bug in a timely manner. + validations: + required: true + + - type: textarea + id: expectedBehavior + attributes: + label: What is expected to happen? + validations: + required: true + + - type: textarea + id: actualBehavior + attributes: + label: What is the actual behavior? + validations: + required: true + + - type: textarea + id: reproductionSteps + attributes: + label: Reproduction Steps? + description: | + Please provide as much detail as possible to help us reproduce the behavior. + If possible please provide a link to a public repository containing a project or solution that reproduces the behavior. + validations: + required: true + + - type: textarea + id: additionalInformation + attributes: + label: Additional Information? + + - type: textarea + id: dotnetVersion + attributes: + label: Dotnet Information + description: | + ```powershell + PS C:\> dotnet --info + # paste output here + ``` + validations: + required: true + + - type: textarea + id: sdkVersion + attributes: + label: SDK Version + description: | + ```powershell + # replace the path with the appropriate path to the Okta.Xamarin.dll on your system + PS C:\> [System.Reflection.Assembly]::LoadFrom("C:\Okta.Xamarin.dll").GetName().Version + # paste output here + ``` + validations: + required: true + + - type: textarea + id: osVersion + attributes: + label: OS version + description: | + ```console + # On Linux: + $ cat /etc/os-release + + # On Mac: + $ uname -a + + # On Windows: + C:\> wmic os get Caption, Version, BuildNumber, OSArchitecture + + # paste output here + ``` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 3ba13e0c..dc46de32 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1 +1,5 @@ +contact_links: + - name: Developer Forum + url: https://devforum.okta.com/ + about: Get help with building your applicaiton on the Okta Platform. blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 5f31b40f..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project - ---- - - - - -## User story - - - -## Proposed solution - - - -## Alternatives considered - - - -## Additional information - - diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..d8f1d83d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +name: Feature Request +description: Request a new feature for this SDK? +labels: [ enhancement ] +body: + - type: textarea + id: description + attributes: + label: Describe the feature request? + description: | + Please leave a helpful description of the feature request here. + validations: + required: true + + - type: textarea + id: resources + attributes: + label: New or Affected Resource(s) + description: | + Please list the new or affected resources + validations: + required: true + + - type: textarea + id: documentation + attributes: + label: Provide a documentation link + description: | + Please provide any links to the documentation that is at + https://developer.okta.com/. This will help us with this + feature request. + - type: textarea + id: additional + attributes: + label: Additional Information? diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 00000000..2f585c56 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,4 @@ +# Security Policy + +## Report a Vulnerability +At Okta we take the protection of our customers’ data very seriously. If you need to report a vulnerability, please visit https://www.okta.com/vulnerability-reporting-policy/ for more information. \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index a90e0822..094b2b5b 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,32 +1,36 @@ - - - -## Issue \# - - - -## Code - -- [ ] Unit test(s) -- [ ] Implementation - - -## Current behavior - - - -## Desired behavior - - - -## Additional Context - - +## Summary + + + +Fixes # + +## Type of PR + +- [ ] Bug Fix (non-breaking fixes to existing functionality) +- [ ] New Feature (non-breaking changes that add new functionality) +- [ ] Documentation update +- [ ] Test Updates +- [ ] Other (Please describe the type) + +## Test Information + +- [ ] My PR required test updates + +Dotnet Version: +Os Version: + +## Signoff +- [ ] I have submitted a CLA for this PR +- [ ] Each commit message explains what the commit does +- [ ] I have updated documentation to explain what my PR does +- [ ] My code is covered by tests if required +- [ ] I did not edit any automatically generated files \ No newline at end of file