Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe in JBS before PR #141

Closed
wants to merge 1 commit into from
+4 −0
Closed

Describe in JBS before PR #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/guide/working-with-pull-requests.md
View file
Original file line number Diff line number Diff line change
@@ -10,6 +10,10 @@ Once you have made a change that you want to integrate into an OpenJDK code base

This section also assumes that you have already read [I have a patch, what do I do?] and followed **all** the steps there.

::: {.note}
Please note that the description of a change should always be in the JBS issue. The [GitHub](https://github.com) PR can be a good place to discuss technical implementation details regarding your change, but it's not the right place to describe the problem. Make sure you have a proper problem description in your JBS issue before publishing a PR.
:::

## Think once more

All code reviews in OpenJDK are done in public. Once you open your PR for public review the internet can see it and comment on it. Make sure your code is ready for it. Look through your comments, make sure that temporary code is gone, and make sure you have sanitized your method and variable names. Also, make sure you understand your code. Why is it working? What are the potential pitfalls? What are the edge-cases? If you haven't already answered all these questions in the mail conversation that preceded this PR, it's likely that you will need to answer them during the review.