From 20c458bfe7aa1059a9a6d0764b100f6716eaee6a Mon Sep 17 00:00:00 2001 From: Huyen Nguyen <25715018+huyenltnguyen@users.noreply.github.com> Date: Mon, 26 Jul 2021 00:26:49 +0700 Subject: [PATCH] chore: update issue templates (#42999) --- .../01--issues-with-coding-challenges.md | 32 +++++++++-------- .../02--issues-with-software-on-platforms.md | 34 +++++++++---------- ...ssues-with-content-on-articles-and-docs.md | 14 +++++--- ...equest-for-freecodecamp-org-s-platforms.md | 24 +++++++------ 4 files changed, 57 insertions(+), 47 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01--issues-with-coding-challenges.md b/.github/ISSUE_TEMPLATE/01--issues-with-coding-challenges.md index 83f79dc610..6c8ef52913 100644 --- a/.github/ISSUE_TEMPLATE/01--issues-with-coding-challenges.md +++ b/.github/ISSUE_TEMPLATE/01--issues-with-coding-challenges.md @@ -10,13 +10,13 @@ assignees: '' NOTE: If you're reporting a security issue, don't create a GitHub issue. Instead, email security@freecodecamp.org. We will look into it immediately. --> -**Affected page** -Add a link to the coding challenge with the problem. +## Affected page + +## Your code -**Your code** -Copy and paste the code from the editor that you used in between the back-ticks below: + ``` @@ -25,21 +25,23 @@ Copy and paste the code from the editor that you used in between the back-ticks ``` -**Expected behavior** -Add a clear and concise description of what you expected to happen. +## Expected behavior + +## Screenshots -**Screenshots** -If applicable, add screenshots to help explain your problem. you can drag and drop, png, jpg, gif, etc. in this box. + +## System + -**System (please complete the following information):** - - Device: [e.g. iPhone6, Laptop] - - OS: [e.g. iOS 14, Windows 10, Ubuntu 20.4] - - Browser: [e.g. chrome, safari] - - Version: [e.g. 22] +- Device: [e.g. iPhone6, Laptop] +- OS: [e.g. iOS 14, Windows 10, Ubuntu 20.4] +- Browser: [e.g. chrome, safari] +- Version: [e.g. 22] -**Additional context** -Add any other context about the problem here. +## Additional context + + diff --git a/.github/ISSUE_TEMPLATE/02--issues-with-software-on-platforms.md b/.github/ISSUE_TEMPLATE/02--issues-with-software-on-platforms.md index 6e218bdd74..df032a5c6c 100644 --- a/.github/ISSUE_TEMPLATE/02--issues-with-software-on-platforms.md +++ b/.github/ISSUE_TEMPLATE/02--issues-with-software-on-platforms.md @@ -1,24 +1,22 @@ --- -name: 'Report issues with software on freeCodeCamp.org''s platforms' +name: "Report issues with software on freeCodeCamp.org's platforms" about: Report a software bug on /learn, /news, Community Forum, Code Radio or any of the platforms. title: '' labels: 'type: bug, status: waiting triage' assignees: '' - --- +## Affected page -**Affected page** -Add a Link to the page with the problem. + +## To reproduce - -**To Reproduce** Steps to reproduce the behavior: 1. Go to '...' @@ -26,21 +24,23 @@ Steps to reproduce the behavior: 3. Scroll down to '....' 4. See error -**Expected behavior** -A clear and concise description of what you expected to happen. +## Expected behavior + +## Screenshots -**Screenshots** -If applicable, add screenshots to help explain your problem. you can drag and drop, png, jpg, gif, etc. in this box. + +## System + -**System (please complete the following information):** - - Device: [e.g. iPhone6, Laptop] - - OS: [e.g. iOS 14, Windows 10, Ubuntu 20.4] - - Browser: [e.g. chrome, safari] - - Version: [e.g. 22] +- Device: [e.g. iPhone6, Laptop] +- OS: [e.g. iOS 14, Windows 10, Ubuntu 20.4] +- Browser: [e.g. chrome, safari] +- Version: [e.g. 22] -**Additional context** -Add any other context about the problem here. +## Additional context + + diff --git a/.github/ISSUE_TEMPLATE/03--issues-with-content-on-articles-and-docs.md b/.github/ISSUE_TEMPLATE/03--issues-with-content-on-articles-and-docs.md index 6d22e00443..17f2405020 100644 --- a/.github/ISSUE_TEMPLATE/03--issues-with-content-on-articles-and-docs.md +++ b/.github/ISSUE_TEMPLATE/03--issues-with-content-on-articles-and-docs.md @@ -4,7 +4,6 @@ about: Report issues with content on a specific article, like broken links, typo title: '' labels: 'type: bug, status: waiting triage' assignees: '' - --- -**Describe your problem and how to reproduce it:** +## Affected page + -**Add a Link to the page with the problem:** +## To reproduce + -**Recommended fix, suggestions (how would you update it?):** +## Recommended fix, suggestions + -**If possible, add a screenshot here (you can drag and drop, png, jpg, gif, etc. in this box):** +## Screenshots + + diff --git a/.github/ISSUE_TEMPLATE/04--feature-request-for-freecodecamp-org-s-platforms.md b/.github/ISSUE_TEMPLATE/04--feature-request-for-freecodecamp-org-s-platforms.md index fbd34b6ab8..168c7d96a9 100644 --- a/.github/ISSUE_TEMPLATE/04--feature-request-for-freecodecamp-org-s-platforms.md +++ b/.github/ISSUE_TEMPLATE/04--feature-request-for-freecodecamp-org-s-platforms.md @@ -1,20 +1,24 @@ --- -name: 'Request a new feature on freeCodeCamp.org''s platforms' +name: "Request a new feature on freeCodeCamp.org's platforms" about: Suggest an idea for freeCodeCamp.org's /learn, /news, Community Forum, Code Radio or other platforms title: '' labels: 'type: feature request' 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 [...] +## Is your feature request related to a problem? Please describe. -**Describe the solution you'd like** -A clear and concise description of what you want to happen. + + -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +## Describe the solution you'd like -**Additional context** -Add any other context or screenshots about the feature request here. + + +## Describe alternatives you've considered + + + +## Additional context + +