Skip to content

Commit 713b468

Browse files
committed
Add quick steps to make it easier to see download the code and build
1 parent 15977f4 commit 713b468

File tree

5 files changed

+37
-52
lines changed

5 files changed

+37
-52
lines changed

Sources/WebKit/WebKit.docc/Build&Debug/Build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Building WebKit
1+
# Building Options
22

33
An in depth guide of build options for WebKit.
44

Sources/WebKit/WebKit.docc/GettingStarted/ContributingCode.md

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

33
WebKit has a rigorous code contribution process and policy in place to maintain the quality of code.
44

5-
## Getting setup to contribute
5+
## Getting Setup to Contribute
66

7-
After downloading the code please run the below command.
7+
Please run this command below to setup your environment to make pull requests.
88

99
```Bash
1010
git webkit setup

Sources/WebKit/WebKit.docc/GettingStarted/Introduction.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -45,45 +45,3 @@ It primarily consists of the following components, each inside its own directory
4545
All WebContent processes in a single session (default vs. private browsing) share a single networking session in the networking process.
4646
* **WebInspector / WebDriver** - WebKit’s developer tool & automation tool for Web developers.
4747

48-
## Contributing to WebKit
49-
50-
There are many ways to get involved and contribute to the WebKit Project.
51-
Filing a new bug, fixing a bug, or adding a new feature.
52-
53-
There are three different kinds of contributors in the WebKit project.
54-
55-
* Contributor - This category encompasses everyone. Anyone who files a bug or contributes a code change or reviews a code change is considered as a contributor
56-
* Committer - A committer is someone who has write access to [WebKit's repository](https://github.com/WebKit/WebKit).
57-
* Reviewer - A reviewer is someone who has the right to review and approve code changes other contributors proposed.
58-
59-
See [Commit and Review Policy](https://webkit.org/commit-and-review-policy/) for more details on how to become a committer or a reviewer.
60-
61-
### Staying in Touch
62-
63-
Before getting in touch with WebKit developers using any of the avenues below, make sure that you have checked our page on how to ask [questions about WebKit](https://webkit.org/asking-questions/).
64-
65-
You can find WebKit developers, testers, and other interested parties on the [#WebKit Slack workspace](https://webkit.slack.com/).
66-
[Join the WebKit slack](https://join.slack.com/t/webkit/shared_invite/enQtOTU3NzQ3NTAzNjA0LTc5NmZlZWIwN2MxN2VjODVjNzEyZjBkOWQ4NTM3OTk0ZTc0ZGRjY2MyYmY2MWY1N2IzNTI2MTIwOGVjNzVhMWE),
67-
and stay in touch.
68-
69-
70-
## Getting started with WebKit
71-
72-
### Adding Tools to PATH
73-
74-
For convenience, you can add `Tools/Scripts/` to your path as follows in `~/.zshrc` like so:
75-
76-
```sh
77-
export PATH=$PATH:/Volumes/Data/webkit/Tools/Scripts/
78-
```
79-
80-
where `/Volumes/Data/webkit` is the path to a WebKit checkout.
81-
82-
This will allow you to run various tools you by name instead of typing the full path of the script.
83-
84-
### Updating checkouts
85-
86-
There is a script to update a WebKit checkout: `Tools/Scripts/update-webkit`.
87-
88-
That will replace your old pull request with a new one with the new changes, while also updating the pull request's description with your current commit message.
89-
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Contributors
2+
3+
## Overview
4+
5+
There are three different kinds of contributors in the WebKit project.
6+
7+
* Contributor - This category encompasses everyone. Anyone who files a bug or contributes a code change or reviews a code change is considered as a contributor
8+
* Committer - A committer is someone who has write access to [WebKit's repository](https://github.com/WebKit/WebKit).
9+
* Reviewer - A reviewer is someone who has the right to review and approve code changes other contributors proposed.
10+
11+
See [Commit and Review Policy](https://webkit.org/commit-and-review-policy/) for more details on how to become a committer or a reviewer.

Sources/WebKit/WebKit.docc/WebKit.md

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

33
WebKit is a cross-platform web browser engine. On iOS and macOS, it powers Safari, Mail, iBooks, and many other applications.
44

5-
## Downloading the Source Code
5+
## Getting Up and Running Quickly
66

7-
```
7+
### Downloading the Source Code
8+
9+
```sh
810
git clone https://github.com/WebKit/WebKit.git WebKit
911
```
1012

11-
## Building WebKit
13+
### Building WebKit
1214

13-
```
15+
```sh
1416
cd WebKit
1517
Tools/Scripts/build-webkit
1618
```
1719

18-
## Running Minibrowser
20+
### Running Minibrowser
1921

20-
```
22+
```sh
2123
Tools/Scripts/run-minibrowser
2224
```
2325

26+
### (Optional) Add Scripts Directory to your PATH
27+
28+
```sh
29+
export PATH=$PATH:`pwd`/Tools/Scripts
30+
```
31+
2432
## Contribute
2533

2634
Congratulations! You’re up and running. Now you can begin coding in WebKit and contribute your fixes and new features to the project.
27-
For details on submitting your code to the project, read [Contributing Code](https://webkit.org/contributing-code/).
35+
For details on submitting your code to the project, read <doc:ContributingCode>.
2836

2937
## Feature Status
3038

@@ -45,6 +53,13 @@ On Windows, you will have to build it yourself.
4553
Once your bug is filed, you will receive email when it is updated at each stage in the [bug life cycle](https://webkit.org/bug-life-cycle).
4654
After the bug is considered fixed, you may be asked to download the [latest nightly](https://webkit.org/nightly) and confirm that the fix works for you.
4755

56+
## Staying in Touch
57+
58+
Before getting in touch with WebKit developers using any of the avenues below, make sure that you have checked our page on how to ask [questions about WebKit](https://webkit.org/asking-questions/).
59+
60+
You can find WebKit developers, testers, and other interested parties on the [#WebKit Slack workspace](https://webkit.slack.com/).
61+
[Join the WebKit slack](https://join.slack.com/t/webkit/shared_invite/enQtOTU3NzQ3NTAzNjA0LTc5NmZlZWIwN2MxN2VjODVjNzEyZjBkOWQ4NTM3OTk0ZTc0ZGRjY2MyYmY2MWY1N2IzNTI2MTIwOGVjNzVhMWE),
62+
and stay in touch.
4863

4964
## Topics
5065

@@ -87,4 +102,5 @@ After the bug is considered fixed, you may be asked to download the [latest nigh
87102
- <doc:ContributorMeetings>
88103
- <doc:Licensing>
89104
- <doc:CI>
105+
- <doc:Contributors>
90106
- <doc:Todo>

0 commit comments

Comments
 (0)