Skip to content

Commit 1d7bbd0

Browse files
committed
Add comment about linear history
1 parent a7761c3 commit 1d7bbd0

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/development/git.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
We use the [Git](https://git-scm.com/) version control system for the development of SPM. [GitHub](https://github.com/) is used as the collaborative code hosting platform (with a local mirror using [Gitea](https://gitea.io/)): the authoritative copy of the SPM repository is available at [spm/spm](https://github.com/spm/spm).
44

5-
We provide here instructions to interact with Git using the GitHub Desktop. This mainly concerns Windows developers -- we also mention the command line equivalents when relevant.
5+
We provide here instructions to interact with the SPM repository using the [GitHub Desktop](https://desktop.github.com/). This mainly concerns Windows developers -- we also mention the command line equivalents when relevant.
66

77
## Git Installation
88

@@ -14,7 +14,7 @@ Once installed, you need to authenticate with your [GitHub account](https://docs
1414

1515
* [Authenticating to GitHub](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github)
1616

17-
!!! tip Two-factor authentication (2FA)
17+
!!! tip "Two-factor authentication (2FA)"
1818
Two-factor authentication (2FA) is not required yet but might be by the [end of 2023](https://github.blog/2023-03-09-raising-the-bar-for-software-security-github-2fa-begins-march-13/). See [here](https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa) for instructions on how to configure 2FA on your account.
1919

2020
<!--
@@ -89,6 +89,9 @@ This is equivalent to using `git pull --rebase`.
8989

9090
To apply this setting from GitHub Desktop, you need to open the command prompt by selecting ++"Repository"++ then ++"Open in Command Prompt"++ from the top menu and enter the above command line.
9191

92+
!!! note "Enforcing a linear commit history"
93+
Note that the option to [require a linear history](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#require-linear-history) has been enabled on the SPM repository. This prevents from pushing merge commits to the main branch.
94+
9295
## Clone the SPM repository
9396

9497
Follow [these instructions](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop) with the SPM repository: https://github/spm/spm

0 commit comments

Comments
 (0)