vector/.github/ISSUE_TEMPLATE/feature.yml at master · tinythings/vector · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
name: Feature
type: "Feature"
description: 🚀 Suggest a new feature.
body:
  - type: markdown
    attributes:
      value: |
        Thank you for opening 🚀 feature request!

        For general questions about Vector usage, please see
        https://discussions.vector.dev.

  - type: textarea
    attributes:
      label: A note for the community
      value: |
        <!-- Please keep this note for the community -->
        * Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request
        * If you are interested in working on this issue or have submitted a pull request, please leave a comment
        <!-- Thank you for keeping this note for the community -->

  - type: textarea
    id: use-cases
    attributes:
      label: Use Cases
      description: |
        In order to properly evaluate a feature request, it is necessary to
        understand the use-cases for it.

        Please describe below the _end goal_ you are trying to achieve that has
        led you to request this feature.

        Please keep this section focused on the problem and not on the suggested
        solution. We'll get to that in a moment, below!

  - type: textarea
    id: attempted-solutions
    attributes:
      label: Attempted Solutions
      description: |
        If you've already tried to solve the problem within Vector's existing
        features and found a limitation that prevented you from succeeding, please
        describe it below in as much detail as possible.

        Ideally, this would include real configuration snippets that you tried
        and what results you got in each case.

        Please remove any sensitive information such as passwords before sharing
        configuration snippets and command lines.

  - type: textarea
    id: proposal
    attributes:
      label: Proposal
      description: |
        If you have an idea for a way to address the problem via a change to
        Vector features, please describe it below.

        In this section, it's helpful to include specific examples of how what
        you are suggesting might look in configuration files, or on the command line,
        since that allows us to understand the full picture of what you are proposing.

        If you're not sure of some details, don't worry! When we evaluate the
        feature request we may suggest modifications as necessary to work within the
        design constraints of Vector.

  - type: textarea
    id: references
    attributes:
      label: References
      description: |
        Are there any other GitHub issues, whether open or closed, that are
        related to the problem you've described above or to the suggested solution? If
        so, please create a list below that mentions each of them. For example:

        - #7023

  - type: input
    id: version
    attributes:
      label: Version
      description: |
        Please paste the output of running `vector --version`.

        This will record which version was current at the time of your feature request,
        to help manage the request backlog.