Create 05-review file and addition of possible topics#23
Conversation
✅ Deploy Preview for how-to-git ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
addition of mdx
### For what are Reviews good for?
request from author update
### author review
bulletpoints
as a reviewer
| It makes more sense, if the person to review it is not involved in that specific topic, but is close to the it. | ||
|
|
||
| - To create a PR review, you first open a [Pull Request](../docs/03-parallel-topics.mdx#merge-branches). | ||
| - On the top right you can choose who to assign for the review. |
There was a problem hiding this comment.
Is this top right or more in the middle of the page? Below reviewers
fabioacl
left a comment
There was a problem hiding this comment.
I wrote some comments/suggestions that must be adressed
| When working together on a project, changes are usually made in branches and checked before merging into the main branch. | ||
| Reviews let teammates give feedback, helping you see your work from a fresh perspective and improve it. | ||
| Reviews aren’t just for code; they can also cover documentation, designs, or settings. | ||
| They can even be made required to keep quality and consistency high. |
There was a problem hiding this comment.
What does this sentence mean?
There was a problem hiding this comment.
@despadam what sentence do you mean, there are 4
| For that a Pull Request is opened and, one can choose a review from someone specific. | ||
| It makes more sense, if the person to review it is not involved in that specific topic, but is close to the it. | ||
|
|
||
| - To create a PR review, you first open a [Pull Request](../docs/03-parallel-topics.mdx#merge-branches). |
There was a problem hiding this comment.
Ah ok the link is actually here, but I think it would be best to move it to the top of the section. Instead of explaining first and then giving the link to that section
|
|
||
| - To create a PR review, you first open a [Pull Request](../docs/03-parallel-topics.mdx#merge-branches). | ||
| - On the top right you can choose who to assign for the review. | ||
| - Now you need to wait for the reviewer to be finished |
There was a problem hiding this comment.
| - Now you need to wait for the reviewer to be finished | |
| - Now you just need to wait for the review. |
| ### Make changes as a reviewer | ||
|
|
||
| As a reviewer you will get a notification (depending on your settings) that you are requested. | ||
| 1. You can start the review by clicking on the green button. |
|
|
||
| As a reviewer you will get a notification (depending on your settings) that you are requested. | ||
| 1. You can start the review by clicking on the green button. | ||
| 1. Go to a line of text that you would change, click on the plus symbol :heavy_plus_sign: (Remember, we recommend to always only use one Line per sentence [here](../docs/02-track-changes.mdx#change-files)) |
There was a problem hiding this comment.
I think it is a good idea to add some screenshots
| ### Author handling of Request changes from reviewer | ||
| [Description TODO] | ||
| - accepting them | ||
| - not accepting them | ||
| - adressing them in new issues for later changes? |
There was a problem hiding this comment.
This section is not finished
| [Describe TODO] | ||
| - Best way is to create an issue, assing it to that creator to ask for changes in certain topic | ||
| - person can later create a branche from that issue, create changes and ask you to be the reviewer | ||
| - are there other ways? |
There was a problem hiding this comment.
This section is not finished
Co-authored-by: Fábio Lopes <33908066+fabioacl@users.noreply.github.com>
✅ Deploy Preview for how-to-git ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Co-authored-by: Fábio Lopes <33908066+fabioacl@users.noreply.github.com>
Co-authored-by: Fábio Lopes <33908066+fabioacl@users.noreply.github.com>
Co-authored-by: Fábio Lopes <33908066+fabioacl@users.noreply.github.com>
Co-authored-by: Fábio Lopes <33908066+fabioacl@users.noreply.github.com>
Co-authored-by: Fábio Lopes <33908066+fabioacl@users.noreply.github.com>
Co-authored-by: Fábio Lopes <33908066+fabioacl@users.noreply.github.com>
Co-authored-by: Fábio Lopes <33908066+fabioacl@users.noreply.github.com>
No description provided.