Skip to content

Commit

Permalink
sagemathgh-38624: Fix issue report formatting
Browse files Browse the repository at this point in the history
    
Currently the bug report and failure to build report issue templates
have the environment sections set to render as Markdown. Rather than
actually rendering this as Markdown, GitHub renders these as Markdown
source code which I imagine is not what was intended for these
templates. This PR removes the instructions to render as Markdown source
code, which has the effect of the section rendering as processed
Markdown.

Examples of current formatting:
vincentmacri#6
vincentmacri#7

Examples of new proposed formatting:
vincentmacri#3
vincentmacri#5


### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies
None
    
URL: sagemath#38624
Reported by: Vincent Macri
Reviewer(s): Kwankyu Lee, Vincent Macri
  • Loading branch information
Release Manager committed Sep 12, 2024
2 parents 895dc33 + 796e51c commit 89bf81b
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,8 @@ body:
- **OS**: Ubuntu 20.04
- Sage Version: 9.2
value: |
- **OS**:
- **Sage Version**:
render: markdown
- **OS**:
- **Sage Version**:
validations:
required: true
- type: checkboxes
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/failure_building_from_source.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,8 @@ body:
- **OS**: Ubuntu 20.04
- Sage Version: 9.2
value: |
- **OS**:
- **OS**:
- **Sage Version**:
render: markdown
validations:
required: true
- type: textarea
Expand Down

0 comments on commit 89bf81b

Please sign in to comment.