From fae2f7de4c39b0de9b8b57921e025be12ebbf82c Mon Sep 17 00:00:00 2001 From: Will Winder Date: Fri, 5 Feb 2021 10:52:02 -0500 Subject: [PATCH 1/3] Cleanup github templates. --- .github/ISSUE_TEMPLATE/bug_report.md | 7 ------- .github/ISSUE_TEMPLATE/config.yml | 4 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 13 ------------- .github/ISSUE_TEMPLATE/question.md | 19 ------------------- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- 5 files changed, 6 insertions(+), 41 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 6ed88b6ac6..81326abea7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,13 +7,6 @@ assignees: '' --- - - ### Subject of the issue Describe your issue here. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..fc246db672 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,4 @@ +contact_links: + - name: ❓ Question and Help + url: https://forum.algorand.org/ + about: The issue tracker is not for support questions. Please join our community for help and discussion. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 2565b902ff..721379639e 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,19 +7,6 @@ assignees: '' --- - - - **Is your feature request related to a problem? Please describe.** A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index e400247ecc..0000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: "❓ Question" -about: General questions related to the algorand platform. -title: '' -labels: question -assignees: '' - ---- - -🚨 The issue tracker is not for questions. 🚨 - -As questions here are likely to be closed, listed below are some resources that may be helpful in getting your question answered. - -If you have general, developer or support questions concerning Algorand please see the Algorand Forums https://forum.algorand.org/. - -Additional Developer information is available here: https://developer.algorand.org/ - -NOTE: If this issue relates to security, please use the vulnerability disclosure form here: -https://www.algorand.com/resources/blog/security diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 88382d7b38..7c6fe044a4 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,8 +15,8 @@ It is also a good idea to run tests: ## Summary -Explain the goal of this change and what problem it is solving. Format this cleanly so that it may be used for a commit message, as your changes will be squash-merged. + ## Test Plan -How did you test these changes? Please provide the exact scenarios you tested in as much detail as possible including commands, output and rationale. + From ec1595b0b5c2243416d2ebb4408055a4eb9044d6 Mon Sep 17 00:00:00 2001 From: Will Winder Date: Fri, 5 Feb 2021 10:59:03 -0500 Subject: [PATCH 2/3] More edits --- .../algorand-engineering-team-issue-template.md | 6 +++--- .github/ISSUE_TEMPLATE/bug_report.md | 12 ++++++++---- .github/ISSUE_TEMPLATE/feature_request.md | 12 ++++++------ 3 files changed, 17 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/algorand-engineering-team-issue-template.md b/.github/ISSUE_TEMPLATE/algorand-engineering-team-issue-template.md index 18bf27ad01..254724fe9c 100644 --- a/.github/ISSUE_TEMPLATE/algorand-engineering-team-issue-template.md +++ b/.github/ISSUE_TEMPLATE/algorand-engineering-team-issue-template.md @@ -9,10 +9,10 @@ assignees: '' --- ## Summary -*Describe the problem identified or the general goal of this issue* + ## Scope/Requirements -*What's involved in this issue? What's required to achieve the goal?* + ## Urgency/Relative Priority -*How urgent is this issue? What are the timing considerations to take into account?* + diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 81326abea7..880031609e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,19 +8,23 @@ assignees: '' --- ### Subject of the issue -Describe your issue here. + + ### Your environment + + ### Steps to reproduce -Tell us how to reproduce this issue. + +1. +2. ### Expected behaviour -Tell us what should happen ### Actual behaviour -Tell us what happens instead diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 721379639e..b3df74a87a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,14 @@ assignees: '' --- -**Is your feature request related to a problem? Please describe.** +## Is your feature request related to a problem? Please describe. -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + -**Describe the solution you'd like** +## Describe the solution you'd like. -A clear and concise description of what you want to happen. + -**Additional context** +## Additional context. -Add any other context or screenshots about the feature request here. + From f6d7d43b8fc193b83f3461714fe10ef5af030581 Mon Sep 17 00:00:00 2001 From: Will Winder Date: Tue, 16 Feb 2021 15:08:38 -0500 Subject: [PATCH 3/3] Add security template. --- SECURITY.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 SECURITY.md diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000000..52b3bde6c7 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,7 @@ +# Vulnerability Disclosures + +Algorand takes the security of the platform and of its users very seriously. We recognize the important role of external security researchers and developers in helping keep our community safe. As with most security reward programs, we ask that you use common sense when looking for security bugs. Vulnerabilities must be disclosed to us privately with reasonable time to respond, and avoid compromise of other users and accounts, or loss of funds that are not your own. We do not reward denial of service, spam, or social engineering vulnerabilities. + +If you believe that you have found a security vulnerability you may disclose it here: + +https://www.algorand.com/resources/blog/security