Open
requested to merge github/fork/LostMekka/bugfix/PR-template-wrong-for-windows-users into master
Created by: LostMekka
This PR is motivated by this comment.
The PR template mentions that Windows users should use the Git BASH to run the scripts that generate samples and docs. However, when doing this, Windows path separators (backslashes) will creep into almost all of the generated files, which will result in unwanted changes.
This PR changes the PR template to instruct Windows users to run the scripts inside a docker container instead, which will prevent the above issue.
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
Run the following to build the project and update samples: ./mvnw clean package ./bin/generate-samples.sh ./bin/utils/export_docs_generators.sh
./bin/generate-samples.sh bin/configs/java*
. For Windows users, please run the script in Git BASH. -
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
(I skipped the build and gen scripts, since there are no changes to the actual project)