Skip to content

Commit

Permalink
Improve GitHub templates and VSCode config (#590)
Browse files Browse the repository at this point in the history
  • Loading branch information
StephanTLavavej authored Mar 8, 2020
1 parent d8b5008 commit 08ed0de
Show file tree
Hide file tree
Showing 5 changed files with 48 additions and 7 deletions.
File renamed without changes.
23 changes: 18 additions & 5 deletions docs/ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ having problems with any component that is not the STL, instructions to get
to the right place are there.

**Command-line test case**
STL version (git commit or Visual Studio version):

```
C:\Temp>type repro.cpp
#include <iostream>
Expand Down Expand Up @@ -44,9 +42,24 @@ test failure
```

**Expected behavior**
A clear and concise description of what you expected to happen. Alternatively,
include `static_assert`s or `assert`s in your test case above whose failure
clearly indicates the problem.
A clear and concise description of what you expected to happen.
Alternatively, include `static_assert` or `assert` lines in your
test case above whose failure clearly indicates the problem.

**STL version**
* Option 1: Visual Studio version
* Displayed in Help > About Microsoft Visual Studio
* Example:
```
Microsoft Visual Studio Community 2019 Preview
Version 16.5.0 Preview 5.0
```
* Option 2: git commit hash
* Example:
```
https://github.com/microsoft/STL/commit/2195148
```
**Additional context**
Add any other context about the problem here.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/cxx20-feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: cxx20 Feature
about: For STL maintainers only
title: PAPER_NUMBER PAPER_TITLE
labels: cxx20
assignees: ''

---

**NOTE**
This issue template is for STL maintainers only.
Please use the Bug Report issue template instead.


[PAPER_NUMBER](https://wg21.link/PAPER_NUMBER) PAPER_TITLE

Note: If this link appears to be broken, don't worry! Papers are often
revised during a WG21 meeting before the final vote. When that happens,
there's a delay of a few weeks between the end of the meeting
and the publication of the papers. When the papers are available,
the https://wg21.link redirector will start working.

Feature-test macro:
`#define MACRO_NAME MACRO_VALUE`
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
# Description
Description
===========



# Checklist
Checklist
=========

Be sure you've read README.md and understand the scope of this repo.

Expand Down
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
// Copyright (c) Microsoft Corporation.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
{
"C_Cpp.autoAddFileAssociations": false,
"editor.formatOnSave": true,
"files.associations": {
".clang-format": "yaml",
"**/stl/inc/**": "cpp"
},
"files.eol": "\r\n",
Expand Down

0 comments on commit 08ed0de

Please sign in to comment.