Skip to content

Commit 24d66e0

Browse files
authored
[Docs] Centralize issue reporting in the generator repo (#6)
[Docs] Centralize issue reporting in the generator repo ### Motivation We are trying out a model where all our generator-related repositories report issues in the generator repo, instead of tracking issues per-repository. ### Modifications Updated guidance about where to report issues. ### Result Documentation is updated, hopefully folks will understand why this repo has Issues disabled now. ### Test Plan Previewed locally. Reviewed by: simonjbeaumont Builds: ✔︎ pull request validation (5.8) - Build finished. ✔︎ pull request validation (5.9) - Build finished. ✔︎ pull request validation (nightly) - Build finished. ✔︎ pull request validation (soundness) - Build finished. #6
1 parent cb043c2 commit 24d66e0

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

CONTRIBUTING.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ that your contributions are licensed under the Apache 2.0 license (see
77

88
## How to submit a bug report
99

10-
Please ensure to specify the following:
10+
Please report any issues related to this library in the [swift-openapi-generator](https://github.com/apple/swift-openapi-generator/issues) repository.
11+
12+
Specify the following:
1113

1214
* Commit hash
1315
* Contextual information (e.g. what you were trying to achieve with swift-openapi-runtime)

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ Implement a new transport or middleware by providing a type that adopts one of t
4343

4444
You can also publish your transport or middleware as a Swift package to allow others to use it with their generated code.
4545

46+
## Reporting issues
47+
48+
Please report any issues related to this library in the [swift-openapi-generator](https://github.com/apple/swift-openapi-generator/issues) repository.
49+
4650
## Documentation
4751

4852
To learn more, check out the full [documentation][2].

Sources/OpenAPIRuntime/Documentation.docc/Documentation.md

+4
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ Implement a new transport or middleware by providing a type that adopts one of t
4545

4646
You can also publish your transport or middleware as a Swift package to allow others to use it with their generated code.
4747

48+
### Reporting issues
49+
50+
Please report any issues related to this library in the [swift-openapi-generator](https://github.com/apple/swift-openapi-generator/issues) repository.
51+
4852
## Topics
4953

5054
### Essentials

0 commit comments

Comments
 (0)