8231601: Update CONTRIBUTING.md to clarify process for contributing features plus Skara changes #303
Conversation
…eatures plus Skara changes
|
Additional comments:
|
Webrevs
|
Regarding your additional comments:
Fixed.
You're probably remembering an old version, but it's been 120 for a while now.
Fixed to add an exception for wildcard static imports in tests.
Added a note about this and a pointer to the Web Testing doc. |
/reviewers 2 |
@kevinrushforth |
The "New features / API additions" repeats some things already stated. Is it to make each section independent? |
I wanted the "New features / API additions" section to stand on its own. Once thing that might be redundant now is the following sentence in the "Contributing code and documentation changes" section: "Feature requests, in particular, must be discussed ahead of time and will require significant effort on your part." I think that could be removed or incorporated in "New features / API additions". |
I think that "Contributing to the OpenJFX codebase" should be renamed to something related to a style guide. Then split the testing part to its own subsection. Also, I still find it confusing that "New features / API additions" is not under the code contribution section. There seems to be 2 main sections: reporting bugs / requesting features - these don't involve code, just talk; then there is contributing code, which covers the process for setup, submissions of bugs fixes, submission of features/API, style, and testing (in some order). Wouldn't this be a better flow? |
Yes, I do think the flow could be better. I'll need to put this on hold for a while, but when I get back to it, I'll look at your suggestions and see if I can come up with something that will improve the flow. Btw, the thinking behind putting the "New features / API additions" sections at the end (sort of like an appendix) is that I didn't want it to get in the way of the "here's how you sumbit and review a PR" for bug fixes, which is the more common case. I don't think it achieves that in its current form. |
not sure whether it belongs here, or whether or not it's obviously implied but: I would like to see a bit of clarification on testing of contributions. Right now the sentence might be interpreted to be about running available tests:
add something like:
|
This PR updates the
CONTRIBUTING.md
guide to address the following:Progress
Issue
Download
$ git fetch https://git.openjdk.java.net/jfx pull/303/head:pull/303
$ git checkout pull/303