Skip to content
GitLab

Improve CONTRIBUTING.md

Merged Administrator requested to merge github/fork/sarod/improve-contributing into master

Created by: sarod

Trying to contribute to python Client (#2626) I found that some steps were missing in the CONTRIBUTING.md file.

In this PR I updated CONTRIBUTING.md with what I discovered.

However there are still some things that should be clarified or improved that are not covered by this PR:

  • For instance running mvn integration-test -rf :PythonPetstoreClientTests failed with HTTPConnectionPool(host='localhost', port=80): Max retries exceeded with url: /v2/pet so I guess some server needs to be started before but I couldn't figure out how.
  • The Git-Branches file https://github.com/OpenAPITools/openapi-generator/wiki/Git-Branches seems obsolete

PR checklist

Not applicable

Description of the PR

Indicate that bin/openapi3 scripts should be executed too.

Try to clarify how to run tests:

  • use in sample a client for which tests exist
  • explain where to run the command and how to find the artifactId to use to run the test command