Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve CONTRIBUTING.md #2699

Merged
merged 2 commits into from Apr 22, 2019

Conversation

Projects
None yet
2 participants
@sarod
Copy link
Contributor

commented Apr 19, 2019

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

sarod added some commits Apr 19, 2019

Improve CONTRIBUTING.md
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

@wing328 wing328 added this to the 4.0.0 milestone Apr 22, 2019

@wing328 wing328 merged commit 8344102 into OpenAPITools:master Apr 22, 2019

4 checks passed

Shippable Run 7401 status is SUCCESS.
Details
ci/circleci Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

jimschubert added a commit that referenced this pull request Apr 25, 2019

Merge branch 'master' into rienafairefr-templating
* master: (40 commits)
  Remove quotation marks around {{paramName}} for header params in api-body.mustache (#2727)
  Add FiNC Technologies (#2728)
  fix missing parenthesis for http bearer auth (#2723)
  Add missing closing parenthesis (#2720)
  update perl test with correct body parameter (#2717)
  [Java][Spring] Fix template for reactive implementation with `interfaceOnly` parameter (#2437)
  Bugfix(Perl): Support nested primitive types in ARRARY or HASH for basic object (#2713)
  Remove `-XX:MaxPermSize` (#2712)
  Remove setting generateAliasAsModel in rust server generator (#2714)
  update rust server samples
  Revert "update rust samples"
  update rust samples
  update samples
  [Rust Server] Improve XML support (#2504)
  Improve CONTRIBUTING.md (#2699)
  [PHP][Lumen] Rename template folder (#2707)
  [aspnetcore] Support async tasks and some code cleanups (#2629)
  [C++][Pistache] Fixed #2643 (#2653)
  update petstore samples (#2697)
  [JAVA][Webclient]fix select body for url encoded media type. (#2686)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.