Created by: saigiridhar21
CRAN committee recommended using dontrun
instead of donttest
. The reason is that the generated OpenAPI client library uses some sort of authentication and dontrun
specifies that the example snippets can't be run without defining some additional configuration like API keys/username-password etc. whereas donttest
specifies that examples can be run without any additional configurations manually.
PR checklist
-
Read the contribution guidelines. -
If contributing template-only or documentation-only changes which will change sample output, build the project before. -
Run the shell script(s) under ./bin/
(or Windows batch scripts under.\bin\windows
) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run./bin/{LANG}-petstore.sh
,./bin/openapi3/{LANG}-petstore.sh
if updating the code or mustache templates for a language ({LANG}
) (e.g. php, ruby, python, etc). -
File the PR against the correct branch: master
,4.3.x
,5.0.x
. Default:master
. -
Copy the technical committee to review the pull request if your PR is targeting a particular programming language.
@Ramanth