Contributing: Add tutorial for setting up email and user name on GitHub #351
Conversation
This file contains 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
Adds a simple tutorial for configurting email and name Signed-off-by: Andreia Ocănoaia <[email protected]>
andreia-oca
force-pushed
the
update-contributing
branch
from
cd1633f to
f2c29fb
Compare
teodutu
requested changes
Oct 19, 2024
There was a problem hiding this comment.
Thanks for the contribution. Here's how to make this better:
- To link the PR automatically with guide: Add tutorial for setting up email and user name on GitHub and locally in
git#341, add the textfixes #341anywhere in the commit or PR message. - To fix spellcheck, you need to add the false positive words to these wordlist (make sure to keep them sorted): https://github.com/open-education-hub/actions/tree/main/spellcheck/config
| git config --global user.email "[email protected]" | ||
| ``` | ||
|
|
||
| If you prefer to set this information only for the current repository, omit the --global flag: |
There was a problem hiding this comment.
Suggested change
| If you prefer to set this information only for the current repository, omit the --global flag: | |
| If you prefer to set this information only for the current repository, omit the `--global` flag: |
Alex-deVis
reviewed
Oct 19, 2024
Co-authored-by: Teodor Dutu <[email protected]>
Co-authored-by: Alex Apostolescu <[email protected]>
The [] are not used Signed-off-by: Andreia Ocănoaia <[email protected]>
Alex-deVis
reviewed
Oct 19, 2024
|
|
||
| ### Setting Up GitHub Name and Email | ||
|
|
||
| To avoid common issues with authorship verification (such as `checkpatch` errors](https://github.com/open-education-hub/operating-systems/actions/runs/6590761580/job/17908015178?pr=339#step:3:570)), it is important to make sure that your `git` configuration includes the correct name and email address, matching the ones associated with your GitHub account. |
There was a problem hiding this comment.
Suggested change
| To avoid common issues with authorship verification (such as `checkpatch` errors](https://github.com/open-education-hub/operating-systems/actions/runs/6590761580/job/17908015178?pr=339#step:3:570)), it is important to make sure that your `git` configuration includes the correct name and email address, matching the ones associated with your GitHub account. | |
| To avoid common issues with authorship verification (such as [`checkpatch` errors](https://github.com/open-education-hub/operating-systems/actions/runs/6590761580/job/17908015178?pr=339#step:3:570)), it is important to make sure that your `git` configuration includes the correct name and email address, matching the ones associated with your GitHub account. |
You should've deleted only the closing bracket, now the link is broken.
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.
Adding a tutotial to set email and name for GitHub.