From f2c29fb15cd5a8832f70f2b560063b6380974f41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreia=20Oc=C4=83noaia?= Date: Sat, 19 Oct 2024 10:26:03 +0300 Subject: [PATCH 1/4] contributing: Add tutorial for setting up email and user name on GitHub MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adds a simple tutorial for configurting email and name Signed-off-by: Andreia Ocănoaia --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0805e3aa34..0844725bc6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,3 +70,23 @@ Prefix each commit message with the chapter it belongs to: `software-stack`, `da How a good commit message should look like: 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. 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 "your-email@example.com" +``` + +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 "your-email@example.com" +``` + +These should match the name and email [address associated with your GitHub account ](https://github.com/settings/profile). From 8d97402b234f2d0a8a6ec9495ef9b99490e2ed2e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreia=20Oc=C4=83noaia?= Date: Sat, 19 Oct 2024 10:41:52 +0300 Subject: [PATCH 2/4] Update CONTRIBUTING.md Co-authored-by: Teodor Dutu --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0844725bc6..f47e2442c7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,7 +73,8 @@ The use of `-s` / `--signoff` when creating a commit is optional, but strongly r ### 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. You can configure this globally for all repositories or locally for a specific project. +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 can configure this globally for all repositories or locally for a specific project. To set your Git author information globally, run the following commands: From 605d24119cb743530ada095199a4a4e0d0b5fcdc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreia=20Oc=C4=83noaia?= Date: Sat, 19 Oct 2024 10:42:17 +0300 Subject: [PATCH 3/4] Update CONTRIBUTING.md Co-authored-by: Alex Apostolescu <73755280+Alex-deVis@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f47e2442c7..517f4eb6b1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -90,4 +90,4 @@ git config user.name "Your Name" git config user.email "your-email@example.com" ``` -These should match the name and email [address associated with your GitHub account ](https://github.com/settings/profile). +These should match the name and email address [associated with your GitHub account ](https://github.com/settings/profile). From 70018dec6ba2ed4e0e5bc7d461982c190a4a1aeb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreia=20Oc=C4=83noaia?= Date: Sat, 19 Oct 2024 10:44:07 +0300 Subject: [PATCH 4/4] Removed [] brackets MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The [] are not used Signed-off-by: Andreia Ocănoaia --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 517f4eb6b1..b16c97779a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,7 +73,7 @@ The use of `-s` / `--signoff` when creating a commit is optional, but strongly r ### 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. +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 can configure this globally for all repositories or locally for a specific project. To set your Git author information globally, run the following commands: