Skip to content

Commit

Permalink
Git name and email config publicity warning (#296)
Browse files Browse the repository at this point in the history
There was have been a few cases where people put their real names and
email in user.name and user.email when they didn't intend to due to Git
misleadingly asking for full name and using technical jargon when
describing where it gets used, so putting a warning should help new and
non-technical contributors not accidentally dox themselves.

---------

Co-authored-by: Pieter-Jan Briers <[email protected]>
  • Loading branch information
ShadowCommander and PJB3005 committed Sep 2, 2024
1 parent 5193380 commit fd9ca50
Showing 1 changed file with 4 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ While you're here, install `Python 3.7+` as well if you don't have it already. Y

<hr>

```admonish danger "Name and Email privacy"
When [setting up your `user.name` and `user.email`](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup#_your_identity), know that these are publicly displayed on all commits that you create. If you want to keep your information private, you can set `user.name` to your username instead of your real name, and `user.email` to the one provided by GitHub when the [`Keep my email addresses private`](https://github.com/settings/emails#toggle_visibility) setting is checked in [GitHub Email Settings](https://github.com/settings/emails#primary_email_select_label).
```

Now that you have Git installed, I recommend you read up a bit on the basics of it first and get acquainted with whatever git client you're working with, whether its just command-line (Git Bash) or anything else.

We're going to run through the process of setting up a Git environment for Space Station 14 so that you can **contribute code through pull requests, create your own codebase**, or just **check out the history of the project.**
Expand Down

0 comments on commit fd9ca50

Please sign in to comment.