mirror/plugin-hub
1
0
Fork 0
mirror of https://github.com/runelite/plugin-hub.git synced 2025-12-23 22:48:49 -05:00
Code Issues Packages Projects Releases Wiki Activity

readme: more detailed updating instructions

Browse Source
This commit is contained in:
Rhea
2025-06-30 14:32:52 -04:00
parent 91433820d3
commit f7b1117992
1 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -91,10 +91,20 @@ To update a plugin, simply update the manifest with the most recent commit hash.
It is recommended to open a pull request from a separate branch. You can run the following commands from your `plugin-hub` repository directory to set up a branch:
```bash
$ git remote add upstream https://github.com/runelite/plugin-hub.git # Only necessary if you have not set it before
$ git fetch upstream && git checkout -B <your-plugin-name> upstream/master
# Only necessary if you have not set it before
git remote add upstream https://github.com/runelite/plugin-hub.git
git fetch upstream
git checkout -B <your-plugin-name> upstream/master
# update commit= in plugins/<your-plugin>
git add plugins/<your-plugin>
git commit -m "update <your-plugin>"
git push
```
Once your changes have been merged, you can delete the branch. The next time you would like to update your plugin, you can create the branch again.
Then create a pull request from within the GitHub UI, or using the GitHub CLI via `gh pr create -w`.
Once your changes have been merged, you can delete the branch (`git branch -D <your-plugin-name>`). The next time you would like to update your plugin, you can create the branch again.
## Reviewing
We will review your plugin to ensure it isn't malicious, doesn't [break Jagex's rules](https://secure.runescape.com/m=news/third-party-client-guidelines?oldschool=1),