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.

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

Contributing: Add tutorial for setting up email and user name on GitHub #351

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

andreia-oca
Copy link
Contributor

Adding a tutotial to set email and name for GitHub.

Adds a simple tutorial for configurting email and name

Signed-off-by: Andreia Ocănoaia <[email protected]>
Copy link
Member

@teodutu teodutu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution. Here's how to make this better:

CONTRIBUTING.md Outdated Show resolved Hide resolved
git config --global user.email "[email protected]"
```

If you prefer to set this information only for the current repository, omit the --global flag:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
andreia-oca and others added 3 commits October 19, 2024 10:41
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]>

### 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants