Skip to content

Commit 71be657

Browse files
authored
Update PR documentation (#23620)
This updates the PR docs and explains how to work with PRs, for those who may not know. It was mentioned that this page could explain PRs a bit better, in case some users are not familiar with GitHub or similar forges. Signed-off-by: jolheiser <[email protected]>
1 parent ca0ce9f commit 71be657

File tree

1 file changed

+37
-1
lines changed

1 file changed

+37
-1
lines changed

docs/content/doc/usage/pull-request.en-us.md

+37-1
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,45 @@ menu:
1515

1616
# Pull Request
1717

18+
A Pull Request (PR) is a way to propose changes to a repository.
19+
It is a request to merge one branch into another, accompanied by a description of the changes that were made.
20+
Pull Requests are commonly used as a way for contributors to propose changes and for maintainers to review and merge those changes.
21+
22+
## Creating a pull request
23+
24+
To create a PR, you'll need to follow these steps:
25+
26+
1. **Fork the repository** - If you don't have permission to make changes to the repository directly, you'll need to fork the repository to your own account.
27+
This creates a copy of the repository that you can make changes to.
28+
29+
2. **Create a branch (optional)** - Create a new branch on your forked repository that contains the changes you want to propose.
30+
Give the branch a descriptive name that indicates what the changes are for.
31+
32+
3. **Make your changes** - Make the changes you want, commit, and push them to your forked repository.
33+
34+
4. **Create the PR** - Go to the original repository and go to the "Pull Requests" tab. Click the "New Pull Request" button and select your new branch as the source branch.
35+
Enter a descriptive title and description for your Pull Request and click "Create Pull Request".
36+
37+
## Reviewing a pull request
38+
39+
When a PR is created, it triggers a review process. The maintainers of the repository are notified of the PR and can review the changes that were made.
40+
They can leave comments, request changes, or approve the changes.
41+
42+
If the maintainers request changes, you'll need to make those changes in your branch and push the changes to your forked repository.
43+
The PR will be updated automatically with the new changes.
44+
45+
If the maintainers approve the changes, they can merge the PR into the repository.
46+
47+
## Closing a pull request
48+
49+
If you decide that you no longer want to merge a PR, you can close it.
50+
To close a PR, go to the open PR and click the "Close Pull Request" button. This will close the PR without merging it.
51+
1852
## "Work In Progress" pull requests
1953

20-
Marking a pull request as being a work in progress will prevent that pull request from being accidentally merged. To mark a pull request as being a work in progress, you must prefix its title by `WIP:` or `[WIP]` (case insensitive). Those values are configurable in your `app.ini` file :
54+
Marking a pull request as being a work in progress will prevent that pull request from being accidentally merged.
55+
To mark a pull request as being a work in progress, you must prefix its title by `WIP:` or `[WIP]` (case insensitive).
56+
Those values are configurable in your `app.ini` file:
2157

2258
```ini
2359
[repository.pull-request]

0 commit comments

Comments
 (0)