Create 05-review file and addition of possible topics #23
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ 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
Contributor
Author
fabioacl
reviewed
Oct 7, 2025
| ### What are Reviews good for? | ||
| 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. |
Contributor
There was a problem hiding this comment.
Suggested change
| Reviews aren’t just for code; they can also cover documentation, designs, or settings. | |
| Reviews are not just for code; they can also cover documentation, metadata files, or settings. |
fabioacl
reviewed
Oct 7, 2025
| 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. | ||
| The common types are code reviews, resp. pull request (PR) reviews, but reviews can also be done on other source of text. |
Contributor
There was a problem hiding this comment.
Suggested change
| The common types are code reviews, resp. pull request (PR) reviews, but reviews can also be done on other source of text. | |
| The common types are code reviews, also known as pull request (PR) reviews, but reviews can also be done on other source of text. |
fabioacl
reviewed
Oct 7, 2025
|
|
||
| ### Request a review as an author | ||
| A review should be requested, if the work on a topic has finished. | ||
| If the work on a topic has finished, means the branch can be merged to the main branch. |
Contributor
There was a problem hiding this comment.
Suggested change
| If the work on a topic has finished, means the branch can be merged to the main branch. | |
| Finishing the work on a topic means the branch can be merged to the main branch. |
Contributor
There was a problem hiding this comment.
Also add links here to how pull requests are made
fabioacl
reviewed
Oct 7, 2025
| ### Request a review as an author | ||
| A review should be requested, if the work on a topic has finished. | ||
| If the work on a topic has finished, means the branch can be merged to the main branch. | ||
| For that a Pull Request is opened and, one can choose a review from someone specific. |
Contributor
There was a problem hiding this comment.
Suggested change
| For that a Pull Request is opened and, one can choose a review from someone specific. | |
| To do this, you open a Pull Request and choose someone specific to review it. |
fabioacl
reviewed
Oct 7, 2025
| A review should be requested, if the work on a topic has finished. | ||
| If the work on a topic has finished, means the branch can be merged to the main branch. | ||
| 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. |
Contributor
There was a problem hiding this comment.
Suggested change
| It makes more sense, if the person to review it is not involved in that specific topic, but is close to the it. | |
| It is often best to choose a reviewer who was not directly involved in that topic but is familiar with the project. |
fabioacl
reviewed
Oct 7, 2025
|
|
||
| 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)) |
Contributor
There was a problem hiding this comment.
Suggested change
| 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)) | |
| 2. 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)) |
fabioacl
reviewed
Oct 7, 2025
| 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. |
Contributor
There was a problem hiding this comment.
Is this top right or more in the middle of the page? Below reviewers
fabioacl
reviewed
Oct 7, 2025
| 3. Either add a comment, or choose to make a suggestion (click on the plusminus symbol), which gives you the option to do changes to a sentence. | ||
| - A suggestion can simply be accepted by the author, where as a comment just gives a hint for a change | ||
| 4. Click the green button to start the review or add review to previous. | ||
| 5. When you finsished your comments click the green button for "finish your review" on the top |
Contributor
There was a problem hiding this comment.
Suggested change
| 5. When you finsished your comments click the green button for "finish your review" on the top | |
| 5. When you are finished with your comments click the green button for "finish your review" on the top |
fabioacl
reviewed
Oct 7, 2025
| - A suggestion can simply be accepted by the author, where as a comment just gives a hint for a change | ||
| 4. Click the green button to start the review or add review to previous. | ||
| 5. When you finsished your comments click the green button for "finish your review" on the top | ||
| - This will give a notification to the author for further actions |
Contributor
There was a problem hiding this comment.
Suggested change
| - This will give a notification to the author for further actions | |
| - This will send a notification to the author for further actions |
fabioacl
requested changes
Oct 7, 2025
Contributor
fabioacl
left a comment
fabioacl
left a comment
There was a problem hiding this comment.
I wrote some comments/suggestions that must be adressed
despadam
requested changes
Nov 20, 2025
| 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. |
Contributor
There was a problem hiding this comment.
What does this sentence mean?
|
|
||
| ### Request a review as an author | ||
| A review should be requested, if the work on a topic has finished. | ||
| If the work on a topic has finished, means the branch can be merged to the main branch. |
Contributor
There was a problem hiding this comment.
Also add links here to how pull requests are made
| 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). |
Contributor
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 |
Contributor
There was a problem hiding this comment.
Suggested change
| - 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)) |
Contributor
There was a problem hiding this comment.
I think it is a good idea to add some screenshots
Comment on lines
+44
to
+48
| ### Author handling of Request changes from reviewer | ||
| [Description TODO] | ||
| - accepting them | ||
| - not accepting them | ||
| - adressing them in new issues for later changes? |
Contributor
There was a problem hiding this comment.
This section is not finished
Comment on lines
+57
to
+60
| [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? |
Contributor
There was a problem hiding this comment.
This section is not finished
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.