Update CONTRIBUTING.md to clarify procedures and fix typos #255
Conversation
|
As mentioned in #246 the purpose of this PR is to update CONTRIBUTING.md to align with the updated code review guidelines, and to address a few things that I find myself repeating when responding to pull requests from first time developers. I also fixed a few typos and did other light cleanup along the way. |
|
Note that since this is (currently) a GitHub-only file, there does not need to be a JBS issue since this patch is not destined for the HG repo. |
.github/CONTRIBUTING.md
Outdated
|
|
||
| Update your local repository with the most recent code from the main [repository]((https://github.com/javafxports/openjdk-jfx)), and rebase your branch on top of the latest `develop` branch. We prefer your initial changes to be squashed into a single commit. Later, if we ask you to make changes, add them as separate commits. This makes them easier to review. As a final step before merging we will either ask you to squash all commits yourself or we'll do it for you. | ||
| If there isn't already a bug filed in [JBS](https://bugs.openjdk.java.net), then please file one at [bugreport.java.com](http://bugreport.java.com/). A JBS bug ID is needed even if you have already filed an issue in the GitHub issue tracker. A GitHub issue can be used as a convenience, but JBS is the official bug database for the OpenJFX Project. Once you submit a pull request, you can add the "github-bug" label on the JBS bug, along with an Issue link to the PR. If you don't have direct JBS access, one of the Project Committers will do this for you. |
There was a problem hiding this comment.
If you don't have direct JBS access, one of the Project Committers will do this for you.
Authors also have JBS access.
There was a problem hiding this comment.
Right, I'll fix this to say "Committers or Authors".
|
For some reason, my last commit didn't trigger a CI build. It might be related to the reported GitHub outage. In any case, all this most recent commit does is add 2 words to a sentence in CONTRIBUTING.md, so we can live without the CI build. |
The outage is reported to be fixed, and the CI builds are in progress, although the Appveyor build hasn't run yet.. I'll merge this in anyway, since any failure would be due to a CI problem not a real problem. |
fixes #246