You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+22-2
Original file line number
Diff line number
Diff line change
@@ -31,7 +31,7 @@ Please file the pull request against the correct branch, e.g. `master` for non-b
31
31
32
32
All the code generators can be found in [modules/openapi-generator/src/main/java/org/openapitools/codegen/languages](https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages)
33
33
34
-
If you want to add a new generator, follow the [new-generator](https://openapi-generator.tech/docs/new-generator) guide.
34
+
If you want to add a new generator, follow the [new-generator](https://openapi-generator.tech/docs/new-generator) guide.
35
35
36
36
### Templates
37
37
@@ -84,6 +84,26 @@ For [Vendor Extensions](https://github.com/OAI/OpenAPI-Specification/blob/master
84
84
- For language-specified vendor extension, put it in the form of `x-{lang}-{extension-name}`. e.g. `x-objc-operation-id`, `x-java-feign-retry-limit`
85
85
- For a list of existing vendor extensions in use, please refer to https://github.com/openapitools/openapi-generator/wiki/Vendor-Extensions. If you've added new vendor extensions as part of your PR, please update the wiki page.
86
86
87
+
### Building
88
+
89
+
The `openapi-generator-cli` can be built using the following command. This will generate the `openapi-generator-cli.jar` in the `modules/openapi-generator-cli/target` directory without running the tests and generating the Javadocs.
java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar help
105
+
```
106
+
87
107
### Testing
88
108
89
109
To add test cases (optional) covering the change in the code generator, please refer to [modules/openapi-generator/src/test/java/org/openapitools/codegen](https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/test/java/org/openapitools/codegen)
@@ -112,5 +132,5 @@ See [OpenAPI Tools wiki](https://github.com/OpenAPITools/openapi-generator/wiki/
112
132
- File a PR with meaningful title, description and commit messages
113
133
- Make sure the option "Allow edits from maintainers" in the PR is selected so that the maintainers can update your PRs with minor fixes, if needed.
114
134
- Recommended git settings
115
-
-`git config core.autocrlf input` to tell Git convert CRLF to LF on commit but not the other way around
135
+
-`git config core.autocrlf input` to tell Git convert CRLF to LF on commit but not the other way around
116
136
- To close an issue (e.g. issue 1542) automatically after a PR is merged, use keywords "fix", "close", "resolve" in the PR description, e.g. `fix #1542`. (Ref: [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/))
0 commit comments