Skip to content

Commit 9d2c918

Browse files
committed
docs: 📝 Updated issue template, readme.md
Updated issue template to include information about opening issues in base library.
1 parent b4c15ee commit 9d2c918

File tree

6 files changed

+785
-4
lines changed

6 files changed

+785
-4
lines changed

.github/ISSUE_TEMPLATE/1-bug-report.yaml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,32 @@ body:
99
Thank you for taking the time to fill out this bug report!
1010
Please note that contributor time is limited, and we might not get back to you immediately.
1111
Also make sure to check if [an existing issue](https://github.com/gibahjoe/openapi-generator-dart/issues) matches yours.
12+
13+
- type: markdown
14+
attributes:
15+
value: |
16+
**Please read before submitting:**
17+
This library wraps the [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) to provide Dart/Flutter codegen.
18+
Some issues may come from the underlying generator, not from this library.
19+
If the issue you are experiencing is related to the generated code, then you need to open an issue on the [OpenAPI Generator repo](https://github.com/OpenAPITools/openapi-generator/issues).
20+
[Click here to learn more](https://github.com/gibahjoe/openapi-generator-dart#note)
21+
22+
- type: dropdown
23+
attributes:
24+
label: Is your issue related to the code that was generated?
25+
options:
26+
- No, my issue is with the openapi-generator-dart wrapper/config
27+
- Yes, my issue is with the generated code (e.g. code errors, structure)
28+
validations:
29+
required: true
30+
31+
- type: markdown
32+
attributes:
33+
value: |
34+
> **If your issue is with the generated code, please [open it on the base OpenAPI Generator repo](https://github.com/OpenAPITools/openapi-generator/issues) instead.**
35+
>
36+
> Issues with generated code are usually caused by the underlying OpenAPI Generator tool, not this wrapper.
37+
1238
- type: textarea
1339
attributes:
1440
label: Description of the bug

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,5 @@ pubspec_overrides.yaml
2222

2323
.iml
2424
openapi_generator_config.json
25+
26+
**/.cxx/

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,8 +145,19 @@ sending your PRs.
145145

146146
## Features and bugs
147147

148-
Please file feature requests and bugs at the [issue tracker][tracker].
148+
###Note:
149+
150+
Some issues may originate from the base OpenAPI Generator library rather than this Dart/Flutter wrapper. This library provides Dart-specific configuration and tools, but the actual code generation is handled by the underlying OpenAPI Generator.
151+
152+
If you encounter problems with the generated code (such as incorrect imports, unexpected code structure, or type mismatches), these are often caused by the base generator, not this wrapper. You may be able to resolve some of these issues by customizing the @Openapi() annotation options:
153+
• template: Allows you to specify a custom code generation template, helping fix issues related to the structure or style of the generated code.
154+
• importMappings: Lets you map OpenAPI model names to custom Dart imports, which helps fix problems with incorrect or missing import statements in the generated code.
155+
• typeMappings: Allows you to map OpenAPI schema types to your own Dart types, which is useful for resolving issues where generated classes don’t match your project’s types or when you need to substitute types for better compatibility.
149156

150-
[tracker]: https://github.com/gibahjoe/openapi-generator-dart/issues
157+
If the issue is specifically with the generated code, please open your issue in the original OpenAPI Generator repository.
158+
159+
If you’re unsure where the problem comes from, feel free to open an issue here—we’ll help point you in the right direction.
160+
161+
Please file feature requests and bugs at the [issue tracker][tracker].
151162

152-
<a href="https://www.buymeacoffee.com/gibahjoe" target="_blank"><img src="https://bmc-cdn.nyc3.digitaloceanspaces.com/BMC-button-images/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
163+
[tracker]: https://github.com/gibahjoe/openapi-generator-dart/issues

example/lib/main.dart

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Openapi Generator last run: : 2025-03-07T19:34:28.647173
12
import 'package:flutter/material.dart';
23
import 'package:openapi_generator_annotations/openapi_generator_annotations.dart';
34

@@ -124,4 +125,4 @@ class _MyHomePageState extends State<MyHomePage> {
124125
), // This trailing comma makes auto-formatting nicer for build methods.
125126
);
126127
}
127-
}
128+
}

0 commit comments

Comments
 (0)