[Wiki] Update images and readme
20
README.md
@ -25,10 +25,8 @@ If you want to contribute towards the wiki, will you need to follow the below in
|
||||
> Already having a fork? Skip to the [next Step](#select-target-branch)!
|
||||
|
||||
You need to make a fork of the PlaceholderAPI Repository to contribute towards the wiki.
|
||||
To fork the repository, click the button on the top-right that says "Fork". In the new page, select the account/organisation you want to fork this repository towards and click "Create fork".
|
||||
|
||||
> **Note**
|
||||
> It's important that "Copy the `master` branch only" has been unchecked! Otherwise will only the master branch be copied over, which is not what you want here.
|
||||
To fork the repository, click the button on the top-right that says "Fork". In the new page, select the account/organisation you want to fork this repository towards and make sure to have "Copy the `master` branch only" unchecked, so that the `wiki` branch is copied too.
|
||||
After this, click "Create fork".
|
||||
|
||||
![fork repo](./img/readme/fork.png)
|
||||
|
||||
@ -49,8 +47,8 @@ Depending on the status of your branch can the prompt show different outcomes:
|
||||
- `This branch is not behind the upstream PlaceholderAPI:wiki`
|
||||
Your fork's `wiki` branch is up-to-date with the latest changes from Upstream (This Repository). You don't have to update anything.
|
||||
![upstream up-to-date](./img/readme/up-to-date.png)
|
||||
- `Fetch and merge <number> upstream commits from PlaceholderAPI:wiki`
|
||||
This is shown when your fork's branch is outdated and upstream (This Repository) has changes. Click the `Fetch and merge` button to fetch the latest commits and update your fork's `wiki` branch.
|
||||
- `This branch is out-of-date`
|
||||
Your fork's `wiki` branch is outdated and should be updated. Press the "Update branch" button to do so.
|
||||
![upstream needs update](./img/readme/needs-update.png)
|
||||
|
||||
### Commit changes
|
||||
@ -163,12 +161,17 @@ Here are the following rules:
|
||||
### Make a Pull request
|
||||
After you made your changes is it time to make a Pull request.
|
||||
|
||||
When you go to the upstream repository, should GitHub already show you a notification that you have commits to PR. Click the `Compare & pull request` button to proceed.
|
||||
When you made changes to the branch should GitHub show you a prompt with a button saying "Compare & pull request". This prompt also shows up when you visit the upstream Repository while having changes on your fork.
|
||||
Press the button to proceed.
|
||||
|
||||
![pr prompt](./img/readme/pr-prompt.png)
|
||||
|
||||
By default will GitHub select the `master` branch as the target, which is not what we want. To fix this, click the button saying `base:master` and select the `wiki` branch.
|
||||
|
||||
> **Note**
|
||||
> When the branch selection only shows branches and not the actual repositories does it mean that you're prompted to PR to your own fork.
|
||||
> To fix this, press the "compare across forks" text shown, select `PlaceholderAPI/PlaceholderAPI` as the target repository (left side) and your fork as the source. Then select the wiki branch as mentioned above.
|
||||
|
||||
![create pr](./img/readme/create-pr.png)
|
||||
|
||||
Finally, fill out the Pull request template and submit the Pull request.
|
||||
@ -177,6 +180,9 @@ Congratulations! You've successfully made a Pull request for the wiki.
|
||||
### Questions?
|
||||
If you have any questions, do not hesitate to ask in the [HelpChat Discord][discord] or [open a new discussion][discussion] in this repository. We will be happy to help you.
|
||||
|
||||
### Tools
|
||||
A simple [online-tool][expansion-generator] is provided by Andre601 that allows you to create new entries for expansions in the wiki.
|
||||
|
||||
### Credits
|
||||
- The Wiki is maintained by [Andre601][andre].
|
||||
- We use the [GitHub Wiki Action][action] by [Andrew-Chen-Wang][andrew] to update the PlaceholderAPI wiki through GitHub Actions.
|
||||
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 55 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 12 KiB |
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 9.9 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 12 KiB |