[CONTRIBUTING.md] Suggest running gradle check before opening a PR
#1240
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
krocard
changed the title
gradle check before opening a PR
krocard
changed the title
gradle check before opening a PRgradle check before opening a PR
|
Any opinion on this change? |
|
Sorry I forgot to click "merge" :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I opened a PR that didn't pass the CI (#1239) even after reading CONTRIBUTING.md:
I did run
./gradlew testbut the CI runs the superset./gradlew check.How about referencing the exact command to run before submitting the PR at the end of that line:
It would also be nice to documentIt's referenced in the./gradlew apiDump(only found it after manually fixing the API file), but keeping the instructions short is probably better. What do you think?./gradlew checkerror message.