Extracted CONTRIBUTING.md info #1461
Merged
Conversation
This file contains hidden or 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
BillFarber
reviewed
Nov 16, 2022
CONTRIBUTING.md
Outdated
| 3. Ensure you are using Java 8 or Java 11 | ||
| 4. Verify that you can build the client by running `./gradlew build -x test` | ||
|
|
||
| "Running in the tests" in the context of developing and submitting a pull request refers to running the tests found |
Contributor
There was a problem hiding this comment.
Nitpicky, but are these the right words? Should it simply be "Running the tests"?
Contributor
Author
There was a problem hiding this comment.
Nitpicky in a guide is good.
rjrudin
force-pushed
the
feature/contrib
branch
from
cb53413 to
4c9c842
Compare
BillFarber
approved these changes
Nov 16, 2022
Didn't want this buried in the README. It's a little awkward still because .github/CONTRIBUTING.md exists with a bunch of boilerplate on how to create and submit a PR. That can be cleaned up later. The key is for the top-level CONTRIBUTING.md to describe how to actually develop and test an enhancement. Also removed the "What's new" content from the README. This was a bit random - some for Java 4, some for Java 5.3. The CHANGELOG has all this data too, so I removed it from the README.
rjrudin
force-pushed
the
feature/contrib
branch
from
4c9c842 to
4020275
Compare
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.
Didn't want this buried in the README. It's a little awkward still because .github/CONTRIBUTING.md exists with a bunch of boilerplate on how to create and submit a PR. That can be cleaned up later. The key is for the top-level CONTRIBUTING.md to describe how to actually develop and test an enhancement.
Also removed the "What's new" content from the README. This was a bit random - some for Java 4, some for Java 5.3. The CHANGELOG has all this data too, so I removed it from the README.