diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fe33fdcb1e..c73173c36d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,7 @@ - Search the [open issue](https://github.com/openapitools/openapi-generator/issues) to ensure no one else has reported something similar and no one is actively working on similar proposed change. - If no one has suggested something similar, open an ["issue"](https://github.com/openapitools/openapi-generator/issues) with your suggestion to gather feedback from the community. + - If you're adding a new option to a generator, please consider using the `-t` option with customized templates instead or start a discussion first by opening an issue as we want to avoid adding too many options to the generator. - It's recommended to **create a new git branch** for the change so that the merge commit message looks nicer in the commit history. ## How to contribute @@ -86,6 +87,7 @@ To test the templates, please perform the following: - Run the tests in the sample folder, e.g. in `samples/client/petstore/ruby`, run `mvn integration-test -rf :RubyPetstoreClientTests`. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests) - Finally, git commit the updated samples files: `git commit -a` (`git add -A` if added files with new test cases) +- For new test cases, please add to the [Fake Petstore spec](https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml) 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. diff --git a/docs/generators/README.md b/docs/generators/README.md index 3a1869f4c3..73a2d132d6 100644 --- a/docs/generators/README.md +++ b/docs/generators/README.md @@ -12,6 +12,7 @@ The following generators are available: - [csharp](csharp.md) - [csharp-dotnet2](csharp-dotnet2.md) - [dart](dart.md) + - [dart-jaguar](dart-jaguar.md) - [eiffel](eiffel.md) - [elixir](elixir.md) - [elm](elm.md) @@ -46,6 +47,7 @@ The following generators are available: - [typescript-angular](typescript-angular.md) - [typescript-angularjs](typescript-angularjs.md) - [typescript-aurelia](typescript-aurelia.md) + - [typescript-axios](typescript-axios.md) - [typescript-fetch](typescript-fetch.md) - [typescript-inversify](typescript-inversify.md) - [typescript-jquery](typescript-jquery.md) @@ -60,8 +62,8 @@ The following generators are available: - [cpp-restbed-server](cpp-restbed-server.md) - [csharp-nancyfx](csharp-nancyfx.md) - [erlang-server](erlang-server.md) - - [go-server](go-server.md) - [go-gin-server](go-gin-server.md) + - [go-server](go-server.md) - [haskell](haskell.md) - [java-inflector](java-inflector.md) - [java-msf4j](java-msf4j.md) @@ -103,6 +105,10 @@ The following generators are available: - [openapi-yaml](openapi-yaml.md) +* SCHEMA generators: + - [mysql-schema](mysql-schema.md) + + * CONFIG generators: - [apache2](apache2.md)