Skip to content

Commit

Permalink
Update outdated docs (#428)
Browse files Browse the repository at this point in the history
* Update outdated docs

* Update SECURITY.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CODE_OF_CONDUCT.md

* Update bug-report.md

* Update feature-request.md

* Update task.md
  • Loading branch information
jmakhack authored Jun 13, 2023
1 parent 0c9b86a commit 6a938a5
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 32 deletions.
4 changes: 1 addition & 3 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,4 @@ RuneLite Version:
Add any other context about the issue here.
-->

Please refer to [CONTRIBUTING.md](https://github.com/jmakhack/hydrate-reminder/blob/master/CONTRIBUTING.md) for info on how to setup, build, run, and test this project. Feel free to ping @jmakhack in the comments below with any questions if needed. Also, join the [Discord](https://discord.gg/RTgxfFW9mS) to meet and engage with other contributors!

[<img src="https://img.shields.io/discord/1023562225790767175?color=%20%237289DA&label=discord&logo=discord&logoColor=%20%237289DA&style=for-the-badge" />](https://discord.gg/RTgxfFW9mS)
Please refer to [CONTRIBUTING.md](https://github.com/jmakhack/hydrate-reminder/blob/master/CONTRIBUTING.md) for info on how to setup, build, run, and test this project. Feel free to ping @jmakhack in the comments below with any questions if needed.
4 changes: 1 addition & 3 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,4 @@ Add any other context or screenshots about the feature request here.
Info such as mockups and/or diagrams can be useful here.
-->

Please refer to [CONTRIBUTING.md](https://github.com/jmakhack/hydrate-reminder/blob/master/CONTRIBUTING.md) for info on how to setup, build, run, and test this project. Feel free to ping @jmakhack in the comments below with any questions if needed. Also, join the [Discord](https://discord.gg/RTgxfFW9mS) to meet and engage with other contributors!

[<img src="https://img.shields.io/discord/1023562225790767175?color=%20%237289DA&label=discord&logo=discord&logoColor=%20%237289DA&style=for-the-badge" />](https://discord.gg/RTgxfFW9mS)
Please refer to [CONTRIBUTING.md](https://github.com/jmakhack/hydrate-reminder/blob/master/CONTRIBUTING.md) for info on how to setup, build, run, and test this project. Feel free to ping @jmakhack in the comments below with any questions if needed.
4 changes: 1 addition & 3 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,4 @@ in order to consider this task completed.
Add any other notes regarding the task if needed.
-->

Please refer to [CONTRIBUTING.md](https://github.com/jmakhack/hydrate-reminder/blob/master/CONTRIBUTING.md) for info on how to setup, build, run, and test this project. Feel free to ping @jmakhack in the comments below with any questions if needed. Also, join the [Discord](https://discord.gg/RTgxfFW9mS) to meet and engage with other contributors!

[<img src="https://img.shields.io/discord/1023562225790767175?color=%20%237289DA&label=discord&logo=discord&logoColor=%20%237289DA&style=for-the-badge" />](https://discord.gg/RTgxfFW9mS)
Please refer to [CONTRIBUTING.md](https://github.com/jmakhack/hydrate-reminder/blob/master/CONTRIBUTING.md) for info on how to setup, build, run, and test this project.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected] or on the [Discord](https://discord.gg/RTgxfFW9mS). All
reported by contacting the project team. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
12 changes: 2 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# How to Contribute

Hey, it's nice to see fellow software developers interested in contributing to a project that aims to assist OSRS players in living a healthy lifestyle. Come join the [Discord](https://discord.gg/RTgxfFW9mS) to meet fellow contributors, to ask any questions, or to just say hi!
Hey, it's nice to see fellow software developers interested in contributing to a project that aims to assist OSRS players in living a healthy lifestyle.

Before contributing to a bugfix or feature, please search [Issues](https://github.com/jmakhack/hydrate-reminder/issues) to see if the request already exists and/or is currently being worked on. If not, create a [New Issue](https://github.com/jmakhack/hydrate-reminder/issues/new/choose) describing the enhancement or bugfix for the plugin. No pull requests should be created without an associated issue. If you plan to work on an issue, just leave a comment on the issue asking to pick it up and then you're free to work on it (unless someone previously commented the same).

When making any code changes, please make sure to run the build using [JDK 8](https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html).
When making any code changes, please make sure to run the build using [JDK 13](https://www.oracle.com/java/technologies/javase/jdk13-archive-downloads.html).

Make sure to ensure that no newly added functionality goes against [Jagex's rules](https://secure.runescape.com/m=news/another-message-about-unofficial-clients?oldschool=1).
If adding any third party dependencies, follow the guide found at [plugin-hub](https://github.com/runelite/plugin-hub#third-party-dependencies).
Expand Down Expand Up @@ -55,11 +55,3 @@ This issue commonly occurs whenever there is a certain mismatch in RuneLite vers
### Why are there two instances of the hydrate reminder plugin visible in the RuneLite client sidebar when I run the project?

This usually indicates that you already have the hydrate reminder plugin installed on the RuneLite client from the PluginHub. This is usually not an issue however. If you do want to remove the duplicate plugin, open RuneLite independently and uninstalled the hydrate reminder plugin that was installed from the PluginHub. Afterwards, run the project again and there should only be one instance of the plugin visible.

### Where can I get additional help on any issues and/or development questions?

Besides just leaving a comment on any GitHub issues or pull requests, the [Discord](https://discord.gg/RTgxfFW9mS) server is an excellent place where you can ask any questions you may have. Even if there are no questions to ask, it is still a great community to join and say hi!

### Does the project maintainer bite?

~~maybe~~ I would never do such a thing (。•̀ᴗ-)✧
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,6 @@
<img src="https://i.imgur.com/bztOLOO.png" />
</p>

<p align="center">
<a href="https://discord.gg/RTgxfFW9mS" alt="Discord">
<img src="https://img.shields.io/discord/1023562225790767175?color=%20%237289DA&label=discord&logo=discord&logoColor=%20%237289DA&style=for-the-badge" />
</a>
</p>

<br />

<p align="center">
<a href="https://runelite.net/plugin-hub/show/hydrate-reminder" alt="Plugin Rank">
<img src="https://img.shields.io/endpoint?style=for-the-badge&url=https%3A%2F%2Fi.pluginhub.info%2Fshields%2Frank%2Fplugin%2Fhydrate-reminder" />
Expand Down Expand Up @@ -56,7 +48,7 @@ Never forget to drink water while exploring the world of Old School RuneScape ev

![hydrate_water_dance](https://user-images.githubusercontent.com/1442227/125190916-7ff58a00-e1f4-11eb-8566-1a10561c7fee.gif)

Any questions, comments, and/or feedback? Fill out the [feedback form](https://forms.gle/aZrqFvTP8LWZ1toi9) or join the [Discord](https://discord.gg/RTgxfFW9mS).
Any questions, comments, and/or feedback? Fill out the [feedback form](https://forms.gle/aZrqFvTP8LWZ1toi9).

## Plugin Features (v1.1.1)

Expand Down Expand Up @@ -118,7 +110,7 @@ Detailed instructions on how to achieve this can be found on the [RuneLite wiki]
## Contributing

Anyone is welcome to contribute to this project repository in any capacity.
Before contributing to this project, please go through the [How to Contribute](CONTRIBUTING.md) guide to understand expectations for this project and for info on how to properly setup and build the project. Also join the [Discord](https://discord.gg/RTgxfFW9mS) to ask any questions and engage with other project contributors.
Before contributing to this project, please go through the [How to Contribute](CONTRIBUTING.md) guide to understand expectations for this project and for info on how to properly setup and build the project.

Other useful resources include the [RuneLite wiki](https://github.com/runelite/runelite/wiki) and [OSRSBox's Writing RuneLite Plugins](https://www.osrsbox.com/blog/2018/08/10/writing-runelite-plugins-part-1-building/) blog post.
It is recommended to use the [IntelliJ IDEA](https://www.jetbrains.com/idea/) development environment for this project.
Expand Down
2 changes: 0 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,3 @@
Check to see if the vulnerability has already been reported in [Issues](https://github.com/jmakhack/hydrate-reminder/issues).
Report any newly discovered vulnerabilities by submitting a [bug report](https://github.com/jmakhack/hydrate-reminder/issues/new?assignees=&labels=bug&template=bug-report.md&title=%5BBUG%5D) with details about the vulnerability.
Be sure to include the Operating System and RuneLite version as part of the description (i.e. Windows 10, RuneLite 1.8.32).

To discuss any potential vulnerabilites or related security concerns, please join the [Discord](https://discord.gg/RTgxfFW9mS).

0 comments on commit 6a938a5

Please sign in to comment.