diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index d44e7866e7d..f18c393ac4a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,7 +3,7 @@ - [ ] Read the [contribution guidelines](https://github.com/openapitools/openapi-generator/blob/master/CONTRIBUTING.md). - [ ] Ran the shell script under `./bin/` to update Petstore sample so that CIs can verify the change. (For instance, only need to run `./bin/{LANG}-petstore.sh` and `./bin/security/{LANG}-petstore.sh` if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in `.\bin\windows\`. - [ ] Filed the PR against the correct branch: Default: `master`. -- [ ] Copied the [technical committee](https://github.com/openapitools/openapi-generator/#swagger-codegen-technical-committee) to review the pull request if your PR is targeting a particular programming language. +- [ ] Copied the [technical committee](https://github.com/openapitools/openapi-generator/#openapi-generator-technical-committee) to review the pull request if your PR is targeting a particular programming language. ### Description of the PR diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a9dea0abef1..72bdb08ff41 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,11 +24,11 @@ https://github.com/openapitools/openapi-generator/wiki/FAQ#git ### Code generators -All the code generators can be found in [modules/swagger-codegen/src/main/java/io/swagger/codegen/languages](https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages) +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) ### Templates -All the templates ([mustache](https://mustache.github.io/)) can be found in [modules/swagger-codegen/src/main/resources](https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources). +All the templates ([mustache](https://mustache.github.io/)) can be found in [modules/openapi-generator/src/main/resources](https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources). For a list of variables available in the template, please refer to this [page](https://github.com/openapitools/openapi-generator/wiki/Mustache-Template-Variables) @@ -75,7 +75,7 @@ For [Vendor Extensions](https://github.com/OAI/OpenAPI-Specification/blob/master ### Testing -To add test cases (optional) covering the change in the code generator, please refer to [modules/swagger-codegen/src/test/java/io/swagger/codegen](https://github.com/openapitools/openapi-generator/tree/master/modules/openapi-generator/src/test/java/org/openapitools/codegen) +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) To test the templates, please perform the following: - Update the [Petstore](http://petstore.swagger.io/) sample by running the shell script under `bin` folder. For example, run `./bin/ruby-petstore.sh` to update the Ruby PetStore API client under [`samples/client/petstore/ruby`](https://github.com/openapitools/openapi-generator/tree/master/samples/client/petstore/ruby) For Windows, the batch files can be found under `bin\windows` folder. (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI/Swagger spec from time to time. If you've questions or concerns, please open a ticket to start a discussion) @@ -83,7 +83,7 @@ To test the templates, please perform the following: - Finally, git commit the updated samples files: `git commit -a` (`git add -A` if added files with new test cases) -To start the CI tests, you can run `mvn verify -Psamples` (assuming you've all the required tools installed to run tests for different languages) or you can leverage http://travis-ci.org to run the CI tests by adding your own Swagger-Codegen repository. +To start the CI tests, you can run `mvn verify -Psamples` (assuming you've all the required tools installed to run tests for different languages) or you can leverage http://travis-ci.org to run the CI tests by adding your own openapi-generator repository. ### Tips - Smaller changes are easier to review diff --git a/docs/integration.md b/docs/integration.md index 1430ca6b6b6..fe50d7f7a2a 100644 --- a/docs/integration.md +++ b/docs/integration.md @@ -28,6 +28,6 @@ cd /var/tmp/perl/petstore Some generators also generate CI/CD configuration files (.travis.yml) so that the output will be ready to be tested by the CI (e.g. Travis) -If you're looking for the configuration files of a particular CI that is not yet supported, please open an [issue](https://github.com/swagger-api/swagger-codegen/issues/new) to let us know. +If you're looking for the configuration files of a particular CI that is not yet supported, please open an [issue](https://github.com/openapitools/openapi-generator/issues/new) to let us know. [Back to OpenAPI-Generator's README page](../README.md) diff --git a/modules/openapi-generator/src/main/resources/sinatra/README.md b/modules/openapi-generator/src/main/resources/sinatra/README.md index c5b8cfffe77..bf132cb042a 100644 --- a/modules/openapi-generator/src/main/resources/sinatra/README.md +++ b/modules/openapi-generator/src/main/resources/sinatra/README.md @@ -14,7 +14,7 @@ sinatra-cross_origin ``` ## Getting started -This sample was generated with the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. +This sample was generated with the [OpenAPI Generator](https://github.com/openapitools/openapi-generator) project. ``` rackup -p 4567 config.ru