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

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

Closed
wants to merge 4 commits into from
Closed

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f2c29fb
contributing: Add tutorial for setting up email and user name on GitHub
andreia-oca Oct 19, 2024
8d97402
Update CONTRIBUTING.md
andreia-oca Oct 19, 2024
605d241
Update CONTRIBUTING.md
andreia-oca Oct 19, 2024
70018de
Removed [] brackets
andreia-oca Oct 19, 2024
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
21 changes: 21 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,3 +70,24 @@ Prefix each commit message with the chapter it belongs to: `software-stack`, `da
How a good commit message should look like: <https://cbea.ms/git-commit/>

The use of `-s` / `--signoff` when creating a commit is optional, but strongly recommended.

### 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.

You can configure this globally for all repositories or locally for a specific project.

To set your Git author information globally, run the following commands:

```bash
git config --global user.name "Your Name"
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:


```bash
git config user.name "Your Name"
git config user.email "[email protected]"
```

These should match the name and email address [associated with your GitHub account ](https://github.com/settings/profile).
Loading