|
1 | | -name: Feature Request |
2 | | -description: Suggest a new feature or enhancement for FlixOpt. |
| 1 | +name: ✨ Feature Request |
| 2 | +description: Suggest a new feature or enhancement |
3 | 3 | title: "[FEATURE] " |
4 | 4 | labels: ["type: feature"] |
5 | 5 | body: |
6 | 6 | - type: markdown |
7 | 7 | attributes: |
8 | 8 | value: | |
9 | | - Thanks for suggesting a new feature! Please provide as much detail as possible. |
| 9 | + Thanks for suggesting a new feature! |
| 10 | +
|
| 11 | + **Before submitting**: Please search [existing issues](https://github.com/flixOpt/flixopt/issues) and check our [roadmap](https://github.com/flixOpt/flixopt/discussions) to avoid duplicates. |
| 12 | +
|
10 | 13 | - type: checkboxes |
11 | 14 | id: checks |
12 | 15 | attributes: |
13 | | - label: Prerequisite Checks |
| 16 | + label: Prerequisites |
14 | 17 | options: |
15 | | - - label: > |
16 | | - I have searched the [existing issues](https://github.com/flixOpt/flixopt/issues) |
17 | | - and confirmed this feature doesn't already exist. |
18 | | - - label: > |
19 | | - I have checked the [documentation](https://flixopt.github.io/flixopt/latest/) |
20 | | - to ensure this feature isn't already available. |
| 18 | + - label: I have searched existing issues and discussions |
| 19 | + required: true |
| 20 | + - label: I have checked the [documentation](https://flixopt.github.io/flixopt/latest/) |
| 21 | + required: true |
| 22 | + |
| 23 | +- type: dropdown |
| 24 | + id: feature-type |
| 25 | + attributes: |
| 26 | + label: Feature Category |
| 27 | + description: What type of feature is this? |
| 28 | + options: |
| 29 | + - New Component (storage, generation, conversion, etc.) |
| 30 | + - Enhancement to Existing Component |
| 31 | + - New Optimization Feature |
| 32 | + - Data Input/Output Improvement |
| 33 | + - Results/Visualization Enhancement |
| 34 | + - Performance/Solver Improvement |
| 35 | + - API/Usability Improvement |
| 36 | + - Documentation/Examples |
| 37 | + - Other |
| 38 | + validations: |
| 39 | + required: true |
| 40 | + |
21 | 41 | - type: textarea |
22 | 42 | id: problem |
23 | 43 | attributes: |
24 | | - label: Is your feature request related to a problem? |
25 | | - description: > |
26 | | - A clear and concise description of what the problem is. |
27 | | - placeholder: > |
28 | | - I'm always frustrated when modeling [specific energy system scenario]... |
| 44 | + label: Problem Statement |
| 45 | + description: What problem would this feature solve? |
| 46 | + placeholder: | |
| 47 | + Current limitation: "FlixOpt doesn't support [specific energy system component/feature]..." |
| 48 | +
|
| 49 | + Impact: "This prevents users from modeling [specific scenarios]..." |
| 50 | +
|
29 | 51 | - type: textarea |
30 | 52 | id: solution |
| 53 | + attributes: |
| 54 | + label: Proposed Solution |
| 55 | + description: Describe your proposed solution in detail |
| 56 | + placeholder: | |
| 57 | + I propose adding a new component/feature that would... |
| 58 | +
|
| 59 | + Key capabilities: |
| 60 | + - Feature 1 |
| 61 | + - Feature 2 |
| 62 | + - Feature 3 |
31 | 63 | validations: |
32 | 64 | required: true |
33 | | - attributes: |
34 | | - label: Describe the solution you'd like |
35 | | - description: > |
36 | | - A clear and concise description of what you want to happen. |
37 | | - placeholder: > |
38 | | - I would like to be able to model [specific component/feature]... |
| 65 | + |
39 | 66 | - type: textarea |
40 | 67 | id: use-case |
| 68 | + attributes: |
| 69 | + label: Use Case & Examples |
| 70 | + description: Provide concrete examples of how this would be used |
| 71 | + placeholder: | |
| 72 | + Real-world scenario: "I'm modeling a microgrid with battery storage and need to..." |
| 73 | +
|
| 74 | + Specific requirements: |
| 75 | + - Must handle [specific constraint] |
| 76 | + - Should support [specific behavior] |
| 77 | + - Would benefit [specific user group] |
41 | 78 | validations: |
42 | 79 | required: true |
43 | | - attributes: |
44 | | - label: Energy System Use Case |
45 | | - description: > |
46 | | - Describe your specific energy system modeling scenario and how this feature would help. |
47 | | - placeholder: > |
48 | | - I'm modeling a district heating system with seasonal thermal storage and need to... |
| 80 | + |
49 | 81 | - type: textarea |
50 | | - id: example |
| 82 | + id: code-example |
51 | 83 | attributes: |
52 | | - label: Desired Code Example (optional) |
53 | | - description: > |
54 | | - If possible, show how you would like to use this feature in code. |
55 | | - placeholder: > |
56 | | - # Example of how the new feature might work |
57 | | - thermal_storage = fx.SeasonalStorage( |
58 | | - label='seasonal_storage', |
59 | | - capacity_mwh=1000, |
60 | | - efficiency=0.95 |
| 84 | + label: Desired API (Optional) |
| 85 | + description: Show how you'd like to use this feature |
| 86 | + placeholder: | |
| 87 | + # Example of proposed API |
| 88 | + component = fx.NewComponent( |
| 89 | + label='example', |
| 90 | + parameter1=value1, |
| 91 | + parameter2=value2 |
61 | 92 | ) |
| 93 | +
|
| 94 | + flow_system.add_component(component) |
62 | 95 | render: python |
63 | | -- type: dropdown |
64 | | - id: component-type |
65 | | - attributes: |
66 | | - label: Component Category (if applicable) |
67 | | - description: What type of energy system component does this relate to? |
68 | | - options: |
69 | | - - Storage (batteries, thermal storage, etc.) |
70 | | - - Generation (PV, wind, CHP, etc.) |
71 | | - - Conversion (heat pumps, boilers, etc.) |
72 | | - - Network/Grid (transmission, distribution) |
73 | | - - Optimization/Calculation (algorithms, solvers) |
74 | | - - Data/Input handling |
75 | | - - Results/Output |
76 | | - - Other |
| 96 | + |
77 | 97 | - type: textarea |
78 | 98 | id: alternatives |
79 | 99 | attributes: |
80 | | - label: Alternatives considered |
81 | | - description: > |
82 | | - Describe any alternative solutions or workarounds you've considered. |
| 100 | + label: Alternatives Considered |
| 101 | + description: What workarounds or alternatives have you tried? |
| 102 | + placeholder: | |
| 103 | + Current workaround: "I'm currently using [existing component] but it doesn't support..." |
| 104 | +
|
| 105 | + Other approaches considered: "I looked into [alternative] but..." |
| 106 | +
|
| 107 | +- type: dropdown |
| 108 | + id: priority |
| 109 | + attributes: |
| 110 | + label: Priority/Impact |
| 111 | + description: How important is this feature for your work? |
| 112 | + options: |
| 113 | + - Critical - Blocking important work |
| 114 | + - High - Would significantly improve workflow |
| 115 | + - Medium - Nice to have enhancement |
| 116 | + - Low - Minor improvement |
| 117 | + |
83 | 118 | - type: textarea |
84 | 119 | id: additional-context |
85 | 120 | attributes: |
86 | | - label: Additional context |
87 | | - description: > |
88 | | - Add any other context, research papers, or examples about the feature request here. |
| 121 | + label: Additional Context |
| 122 | + description: References, papers, examples from other tools, etc. |
| 123 | + placeholder: | |
| 124 | + References: |
| 125 | + - Research paper: [Title and link] |
| 126 | + - Similar feature in [other tool]: [description] |
| 127 | + - Industry standard: [description] |
0 commit comments