Skip to content
This repository has been archived by the owner on Jun 24, 2021. It is now read-only.

Update CONTRIBUTING.md #307

Merged
merged 2 commits into from
Nov 30, 2018
Merged

Update CONTRIBUTING.md #307

merged 2 commits into from
Nov 30, 2018

Conversation

Ciruman
Copy link
Contributor

@Ciruman Ciruman commented Nov 29, 2018

Update CONTRIBUTING documentation to make use of gradle wrapper

@diego4zeiss
Update CONTRIBUTING.md
42d0200 
Update CONTRIBUTING documentation to make use of gradle wrapper
kevinrushforth
kevinrushforth suggested changes Nov 29, 2018
View reviewed changes
.github/CONTRIBUTING.md Outdated
@@ -123,13 +123,13 @@ Please also follow these formatting guidelines:
OpenJFX uses Gradle for its build. Before submitting your changes, run the test suite to make sure that nothing is broken, with:

```sh
gradle all test
./gradlew all test
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The gradlew script is not executable (and must not be), so that should be:

bash ./gradlew all

Otherwise, this looks fine to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proposal change applied. Is it ok now?

.github/CONTRIBUTING.md Outdated
```

If you are changing anything that might possibly affect rendering, you should run a full test with robot enabled:

```sh
gradle -PFULL_TEST=true -PUSE_ROBOT=true all test
./gradlew -PFULL_TEST=true -PUSE_ROBOT=true all test
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proposal change applied. Is it ok now?

@kevinrushforth
Copy link
Collaborator

kevinrushforth commented Nov 29, 2018 •
edited
Loading

@Ciruman Welcome to OpenJFX. Since CONTRIBUTING.md is one of the github-only files (i.e., it does not exist in the master repo), we don't need a JBS issue for it, which we otherwise require. Also, since it is a simple doc change, I can merge it without needing an Oracle Contributor Agreement (OCA) on file. If you wish to contribute any more changes to JavaFX, we will need you to sign the OCA. This file, CONTRIBUTING.md, has the relevant pointers.

@kevinrushforth kevinrushforth added the documentation Updates or additions to documentation label Nov 29, 2018
kevinrushforth
kevinrushforth approved these changes Nov 30, 2018
View reviewed changes
Copy link
Collaborator

@kevinrushforth kevinrushforth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@kevinrushforth kevinrushforth merged commit 86df66f into javafxports:develop Nov 30, 2018
kevinrushforth pushed a commit that referenced this pull request Nov 30, 2018
@diego4zeiss @kevinrushforth
Update CONTRIBUTING.md (#307)
d55528e 
* Update CONTRIBUTING documentation to make use of gradle wrapper
@Ciruman Ciruman deleted the patch-1 branch December 7, 2018 21:45
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@kevinrushforth kevinrushforth kevinrushforth approved these changes

Assignees

@Ciruman Ciruman

Labels
documentation Updates or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Ciruman @kevinrushforth @diego4zeiss