You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Deep Dive/GitHub/Git_Config.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ The WebKit project outlines a simplified recommended setup. This section outline
6
6
7
7
### Forking
8
8
9
-
Since `git` is a decentralized version control system, a local copy can work with any remote that has the same set of shas. GitHub pull requests take advantage of this. After running [`git-webkit setup`](/WebKit/WebKit/wiki/Contributing#setup), the `.git/config` in the local WebKit repository should look something like this:
9
+
Since `git` is a decentralized version control system, a local copy can work with any remote that has the same set of shas. GitHub pull requests take advantage of this. After running [`git-webkit setup`](/Getting Started/ContributingCode#getting-setup-to-contribute), the `.git/config` in the local WebKit repository should look something like this:
10
10
11
11
```
12
12
[remote "origin"]
@@ -22,7 +22,7 @@ Since `git` is a decentralized version control system, a local copy can work wit
22
22
23
23
Now, if a contributor runs `git push fork eng/some-branch`, `eng/some-branch` will be pushed to the remote `fork`, which should correspond to that contributor's personal fork of the WebKit project on GitHub. Likewise, running `git checkout remotes/fork/eng/some-branch` will checkout `eng/some-branch` according to that contributor's `fork` remote.
24
24
25
-
[`git-webkit setup`](/WebKit/WebKit/wiki/Contributing#setup) also configures a remote with a contributors GitHub username. This is because if other contributors would like to checkout code from a pull request which they do not own, contributors will need to add this:
25
+
[`git-webkit setup`](/Getting Started/ContributingCode#getting-setup-to-contribute) also configures a remote with a contributors GitHub username. This is because if other contributors would like to checkout code from a pull request which they do not own, contributors will need to add this:
26
26
27
27
```
28
28
[remote "<username>"]
@@ -34,7 +34,7 @@ to their `.git/config` and run `git checkout remotes/<username>/eng/some-branch`
34
34
35
35
## Configuration Options
36
36
37
-
[`git-webkit setup`](/WebKit/WebKit/wiki/Contributing#setup) automatically sets or prompts the contributor to define a number of `git` configuration options. Most contributors should use the defaults recommended by [`git-webkit setup`](/WebKit/WebKit/wiki/Contributing#setup). This section defines, in detail, what an option does and why the WebKit project recommends a certain setting.
37
+
[`git-webkit setup`](/Getting Started/ContributingCode#getting-setup-to-contribute) automatically sets or prompts the contributor to define a number of `git` configuration options. Most contributors should use the defaults recommended by [`git-webkit setup`](/Getting Started/ContributingCode#getting-setup-to-contribute). This section defines, in detail, what an option does and why the WebKit project recommends a certain setting.
38
38
39
39
### user.email
40
40
@@ -46,7 +46,7 @@ Enter git user email for this repository:
46
46
47
47
The `user.email` option is usually configured globally, and will become the contact information in `git` when authoring or committing a change. This is also the part of a commit that GitHub uses when attributing commits to specific users. The email a contributor defines here should be one of that contributor's emails in GitHub so that changes are correctly attributed to the contributor.
48
48
49
-
The WebKit project asks contributors to define this value for their WebKit repository specifically because a contributor's reported email may change over time, and may even differ between machines. [`git-webkit setup`'s](/WebKit/WebKit/wiki/Contributing#setup) prompt is an effort to make contributors think about what their reported contact information for this specific checkout should be.
49
+
The WebKit project asks contributors to define this value for their WebKit repository specifically because a contributor's reported email may change over time, and may even differ between machines. [`git-webkit setup`'s](/Getting Started/ContributingCode#getting-setup-to-contribute) prompt is an effort to make contributors think about what their reported contact information for this specific checkout should be.
50
50
51
51
Note that the author and committer listed in a `git` commit can easily be spoofed, so `user.email` plays no part in authentication. It is strictly for communication to other contributors.
52
52
@@ -104,7 +104,7 @@ When creating or editing commit messages, `git` will invoke an external editor.
104
104
105
105
## WebKit Options
106
106
107
-
[`git-webkit`] respects a few options that are specific to the `webkitscmpy` library. [`git-webkit setup`](/WebKit/WebKit/wiki/Contributing#setup) does automatically configure some of these, [`metadata/project_config`](/WebKit/WebKit/blob/main/metadata/project_config) also contains a few default values for the project.
107
+
[`git-webkit`] respects a few options that are specific to the `webkitscmpy` library. [`git-webkit setup`](/Getting Started/ContributingCode#getting-setup-to-contribute) does automatically configure some of these, [`metadata/project_config`](/WebKit/WebKit/blob/main/metadata/project_config) also contains a few default values for the project.
Copy file name to clipboardExpand all lines: docs/Deep Dive/GitHub/Migration.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@ If you see something like:
11
11
fatal: not a git repository (or any parent up to mount point /Volumes)
12
12
Stopping at filesystem boundary (GIT_DISCOVERY_ACROSS_FILESYSTEM not set).
13
13
```
14
-
you have a [Subversion checkout](/WebKit/WebKit/wiki/Migration#subversion) and need to migrate to a GitHub checkout.
14
+
you have a [Subversion checkout](#subversion) and need to migrate to a GitHub checkout.
15
15
16
16
If you see something like:
17
17
```
@@ -23,28 +23,28 @@ or:
23
23
origin https://git.webkit.org/git/WebKit (fetch)
24
24
origin https://git.webkit.org/git/WebKit (push)
25
25
```
26
-
you have an [obsolete git mirror](/WebKit/WebKit/wiki/Migration#obsolete-mirror) for how to deal with patches uploaded to bugzilla.) and need to migrate to a GitHub checkout.
26
+
you have an [obsolete git mirror](#obsolete-mirror) for how to deal with patches uploaded to bugzilla.) and need to migrate to a GitHub checkout.
you already have a GitHub checkout, and can skip to [setting up your checkout](/WebKit/WebKit/wiki/Contributing#setup).
33
+
you already have a GitHub checkout, and can skip to [setting up your checkout](/Getting Started/ContributingCode#getting-setup-to-contribute).
34
34
35
35
## Subversion
36
36
37
37
Migrating from a Subversion checkout involves first cloning the WebKit repository with `git clone https://github.com/WebKit/WebKit.git <local path>`. A SSH based clone will work as well, but will require an [SSH key to be uploaded](https://github.com/settings/keys).
38
38
39
-
After your clone completes, [set up your checkout](/WebKit/WebKit/wiki/Contributing#setup). If you don't have local changes in your Subversion checkout, no more migration work is required. If you do have local changes, use `Tools/Scripts/svn-create-patch` to save those changes in a local `.patch` file and then run `Tools/Scripts/svn-apply` to apply that patch to your new GitHub clone. See [below](/WebKit/WebKit/wiki/Migration#webkit-patch) for how to deal with patches uploaded to bugzilla.
39
+
After your clone completes, [set up your checkout](/Getting Started/ContributingCode#getting-setup-to-contribute). If you don't have local changes in your Subversion checkout, no more migration work is required. If you do have local changes, use `Tools/Scripts/svn-create-patch` to save those changes in a local `.patch` file and then run `Tools/Scripts/svn-apply` to apply that patch to your new GitHub clone. See [below](#webkit-patch) for how to deal with patches uploaded to bugzilla.
40
40
41
41
## Obsolete Mirror
42
42
43
43
The repository hosted via [github.com/WebKit/WebKit](https://github.com/WebKit/WebKit) has different commits from the ones hosted on [git.webkit.org](https://git.webkit.org). While it is possible convert an existing checkout, the WebKit team recomends that you freshly clone the WebKit repository with `git clone https://github.com/WebKit/WebKit.git <local path>`. A SSH based clone will work as well, but will require an [SSH key to be uploaded](https://github.com/settings/keys).
44
44
45
-
After your clone completes, [set up your checkout](/WebKit/WebKit/wiki/Contributing#setup). The WebKit team has not built automation to assist in migrating branches from [git.webkit.org](https://git.webkit.org) checkouts to [github.com/WebKit/WebKit](https://github.com/WebKit/WebKit) ones. However, the content on disk in both repositories is identical. That means that something like `git -C <oldpath> diff HEAD~1 | git -C <newpath> apply` will apply a commit from one checkout to the other, assuming the diff of the commit you're moving applies to commit you have checked out.
45
+
After your clone completes, [set up your checkout](/Getting Started/ContributingCode#getting-setup-to-contribute). The WebKit team has not built automation to assist in migrating branches from [git.webkit.org](https://git.webkit.org) checkouts to [github.com/WebKit/WebKit](https://github.com/WebKit/WebKit) ones. However, the content on disk in both repositories is identical. That means that something like `git -C <oldpath> diff HEAD~1 | git -C <newpath> apply` will apply a commit from one checkout to the other, assuming the diff of the commit you're moving applies to commit you have checked out.
46
46
47
-
See [below](/WebKit/WebKit/wiki/Migration#webkit-patch) for how to deal with patches uploaded to bugzilla.
47
+
See [below](#webkit-patch) for how to deal with patches uploaded to bugzilla.
Copy file name to clipboardExpand all lines: docs/Deep Dive/GitHub/Pull_Requests.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ The first step of most pull requests is creating a [bug](https://bugs.webkit.org
8
8
9
9
## Branching
10
10
11
-
Pull request branches are owned by their author, which is why `git-webkit setup`[creates a personal fork of WebKit](/WebKit/WebKit/wiki/Contributing#setup). This means that the WebKit project cannot enforce branching idioms, although there are some suggestions the WebKit team has so that other contributors can more easily access proposed changes. `Tools/Scripts/git-webkit pr` derives it's `eng` prefixed branch from the bug title of the bug associated with a pull request.
11
+
Pull request branches are owned by their author, which is why `git-webkit setup`[creates a personal fork of WebKit](/Getting Started/ContributingCode#getting-setup-to-contribute). This means that the WebKit project cannot enforce branching idioms, although there are some suggestions the WebKit team has so that other contributors can more easily access proposed changes. `Tools/Scripts/git-webkit pr` derives it's `eng` prefixed branch from the bug title of the bug associated with a pull request.
12
12
13
13
We suggest that pull request branch names are prefixed by `eng/` or `dev/` so that contributors are clear which branches contain production code when they add other user's forks as remotes. Notably, [EWS](https://ews-build.webkit.org) is unable to apply changes which come from the branch they are targeting (ie, [EWS](https://ews-build.webkit.org) cannot apply a change from `Contributor/WebKit:main` onto `WebKit/WebKit:main`), so in order to be reviewed, changes must come from a different branch.
14
14
@@ -22,18 +22,18 @@ The WebKit project heavily relies on commit messages to defend project performan
22
22
* High level explanation (optional)
23
23
* Files changes, what was changed, and why
24
24
25
-
`git-webkit setup`[configures `.git/prepare-commit-msg`](/WebKit/WebKit/wiki/Contributing#setup) such that your commit message template is formatted to the standards of the WebKit project.
25
+
`git-webkit setup`[configures `.git/prepare-commit-msg`](/Getting Started/ContributingCode#getting-setup-to-contribute) such that your commit message template is formatted to the standards of the WebKit project.
26
26
27
27
In addition to pull request commits having verbose commit messages, the WebKit project also expects the content of commit messages in the pull request description. This is so that reviewers can provide feedback on the commit message itself.
28
28
29
29
## Reviewing
30
30
31
-
Commits generally require the approval of a [reviewer](https://webkit.org/team/#reviewers), although there are narrow exceptions for test expectation gardening and build fixes. Reviewers will approve pull requests through the GitHub UI by marking pull requests as "Approved." Note that approval from someone who is not a reviewer will not be recognized by [Merge-Queue](/WebKit/WebKit/wiki/Contributing#merge-queue).
31
+
Commits generally require the approval of a [reviewer](https://webkit.org/team/#reviewers), although there are narrow exceptions for test expectation gardening and build fixes. Reviewers will approve pull requests through the GitHub UI by marking pull requests as "Approved." Note that approval from someone who is not a reviewer will not be recognized by [Merge-Queue](/Getting Started/ContributingCode#merge-queue).
32
32
33
33
## Landing
34
34
35
-
Only repository administers have direct commit access, and this is reserved for repairing infrastructure issues. Pull requests should be landed through [Merge-Queue](/WebKit/WebKit/wiki/Contributing#merge-queue), which is achieved by applying [`merge-queue`](https://github.com/WebKit/WebKit/labels?q=merge-queue) or [`unsafe-merge-queue`](https://github.com/WebKit/WebKit/labels?q=unfsafe-merge-queue) label to your pull request.
35
+
Only repository administers have direct commit access, and this is reserved for repairing infrastructure issues. Pull requests should be landed through [Merge-Queue](/Getting Started/ContributingCode#merge-queue), which is achieved by applying [`merge-queue`](https://github.com/WebKit/WebKit/labels?q=merge-queue) or [`unsafe-merge-queue`](https://github.com/WebKit/WebKit/labels?q=unfsafe-merge-queue) label to your pull request.
36
36
37
-
[Merge-Queue](/WebKit/WebKit/wiki/Contributing#merge-queue) will check to make sure a change is reviewed by adding the name of all [reviewers](https://webkit.org/team/#reviewers) who have approved a pull request to the commit message. [Merge-Queue](/WebKit/WebKit/wiki/Contributing#merge-queue) will then check the commit message for `Reviewed by`.
37
+
[Merge-Queue](/Getting Started/ContributingCode#merge-queue) will check to make sure a change is reviewed by adding the name of all [reviewers](https://webkit.org/team/#reviewers) who have approved a pull request to the commit message. [Merge-Queue](/Getting Started/ContributingCode#merge-queue) will then check the commit message for `Reviewed by`.
38
38
39
-
Note that [Merge-Queue](/WebKit/WebKit/wiki/Contributing#merge-queue) will reject pull requests that are labeled by contributors who are not [committers](https://webkit.org/team/#committers).
39
+
Note that [Merge-Queue](/Getting Started/ContributingCode#merge-queue) will reject pull requests that are labeled by contributors who are not [committers](https://webkit.org/team/#committers).
0 commit comments