Bladeren bron

Merge pull request #3 from vector-of-bool:feature/issue-templates

Prepare issue templates
default_compile_flags
vector-of-bool 4 jaren geleden
bovenliggende
commit
d0fe467d6e
No account linked to committer's email address
4 gewijzigde bestanden met toevoegingen van 144 en 0 verwijderingen
  1. +25
    -0
      .github/ISSUE_TEMPLATE/behavior-change-request.md
  2. +62
    -0
      .github/ISSUE_TEMPLATE/bug_report.md
  3. +23
    -0
      .github/ISSUE_TEMPLATE/docs-change.md
  4. +34
    -0
      .github/ISSUE_TEMPLATE/feature_request.md

+ 25
- 0
.github/ISSUE_TEMPLATE/behavior-change-request.md Bestand weergeven

@@ -0,0 +1,25 @@
---
name: Behavior change request
about: Request that an existing behavior be changed or removed.
title: "[TWEAK]"
labels: enhancement
assignees: ''

---

<!--

Please provide as much information as possible to help us address your concern. When completed, please remove an empty sections.

Thank you!

-->

**Existing Behavior and Potential Problems**

[Clearly and concisely describe the existing behavior and what problems it may incur. If possible, include a link to the relevant documentation.]

**Describe Alternatives**

[Clearly describe what modifications could reduce or minimize the problems. Should the problem be removed completely, made default, made non-default, given more alternatives, or otherwise changed?]


+ 62
- 0
.github/ISSUE_TEMPLATE/bug_report.md Bestand weergeven

@@ -0,0 +1,62 @@
---
name: Bug report
about:
Report an unexpected behavior, or a behavior which deviates from what is
stated in the documentation.
title: "[BUG]"
labels: bug
assignees: ''

---

<!--

Please provide as much information as possible to help us fix your issue. When
completed, please remove an empty sections.

Thank you!

-->

**Describe the bug**

[A clear and concise description the misbehavior, as well as what behavior is expected (May be as simple as "doesn't crash"). If possible, include a link to the relevant documentation.]

**Steps to Reproduce**

<!-- As clearly as possible, describe the steps to reproduce the issue -->

1. First step
2. Second step
3. Third step

**`dds` Output**

<!--

If applicable, include the output from `dds`.

PLEASE paste the output in-between the triple-backticks to keep the output
formatted correctly!

-->

```
[paste here]
```

**Desktop (please complete the following information):**

<!--

List the platform(s) and toolsets which are applicable to the issue, and all of the platforms that have been tried.

-->

- Operating System: [e.g. macOS, Linux, Windows]
- Compiler: [e.g. MSVC, GCC, Clang]
- `dds` Version: [e.g. `0.1.0-alpha.2`]

**Additional context**

[Add any other context about the problem here, or delete this section.]

+ 23
- 0
.github/ISSUE_TEMPLATE/docs-change.md Bestand weergeven

@@ -0,0 +1,23 @@
---
name: Documentation issue/request
about:
Report an omission, contradiction, or inaccuracy in the documentation, or
request an addition to the documentation,
title: "[DOCS]"
labels: enhancement,documentation,bug
assignees: ''

---

<!--

Please provide as much information as possible to help us address your concern. When completed, please remove an empty sections.

Thank you!

-->

**Describe the desired documentation change**

[Describe clearly the kind of documentation problem (omission, inaccuracy, contradiction, etc.) and what you would like to see changed. If possible, include a link to the relevant page/section of the documentation. If related to a specific section, provide a link to the section header. If applicable, paste the direct quote(s) from the documentation.]


+ 34
- 0
.github/ISSUE_TEMPLATE/feature_request.md Bestand weergeven

@@ -0,0 +1,34 @@
---
name: Feature request
about: Suggest a new feature or capability for `dds`
title: "[FEATURE]"
labels: enhancement
assignees: ''

---

<!--

Please provide as much information as possible to help us address your concern. When completed, please remove an empty sections.

Before submitting, please consider whether the requested behavior is contrary to the stated goals and non-goals of `dds` itself. If you are unsure whether your request would go against the project's goals, feel free to submit it and we'll discuss it!

Thank you!

-->

**Describe the scenario and circumstances that should be addressed**

[Before describing the requested feature, describe the scenario and circumstances in which it would be a benefit to the user.]

**Describe alternatives you've considered**

[Before describing your preferred solution, consider what alternatives might be available. If you can think of other less-preferable possibilities, describe them here and what drawbacks they may have. Otherwise, remove this section.]

**Describe the solution you'd like**

[Clearly describe the feature and/or workflow you'd like to see made available. If you've described alternatives, state the reason that it should be preferred. If multiple alternatives are equally beneficial, feel free to include them all here.]

**Additional context**

[Add any other context or screenshots about the feature request here.]

Laden…
Annuleren
Opslaan