forked from open-osrs/runelite
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
74a0bf0
commit eafb024
Showing
3,738 changed files
with
125,083 additions
and
164,848 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
# Contributing to runelite | ||
|
||
We'd love for you to contribute to our source code and to make runelite even better than it is | ||
today! | ||
|
||
Check out the Developer's Guide on the [wiki](https://github.com/runelite/runelite/wiki) for setup instructions, and general tips and tricks. | ||
|
||
Here are the guidelines we'd like you to follow: | ||
|
||
- [Question or Problem?](#question) | ||
- [Issues and Bugs](#issue) | ||
- [Submission Guidelines](#submit) | ||
- [Coding Format](#format) | ||
|
||
## <a name="question"></a> Got a Question or Problem? | ||
|
||
If you have questions about how to contribute to runelite, please join our [Discord](https://discord.gg/HN5gf3m) server. | ||
|
||
## <a name="issue"></a> Found an Issue? | ||
|
||
If you find a bug in the source code or a mistake in the documentation, you can help us by | ||
submitting an issue to our [GitHub Repository][github]. Even better you can submit a Pull Request | ||
with a fix. | ||
|
||
**Please see the [Submission Guidelines](#submit) below.** | ||
|
||
## <a name="submit"></a> Submission Guidelines | ||
|
||
### Submitting an Issue | ||
Before you submit your issue search the archive, maybe your question was already answered. | ||
|
||
If your issue appears to be a bug and hasn't been reported, open a new issue. Help us to maximize | ||
the effort we can spend fixing issues and adding new features, by not reporting duplicate issues. | ||
Providing the following information will increase the chances of your issue being dealt with | ||
quickly: | ||
|
||
* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps | ||
* **Java Version and Operating System** - is this a problem with a specific setup? | ||
* **Reproduce the Error** - provide details, if possible, on how to reproduce the error | ||
* **Related Issues** - has a similar issue been reported before? | ||
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit) | ||
|
||
### Submitting a Pull Request | ||
Before you submit your pull request consider the following guidelines: | ||
|
||
* Search [GitHub](https://github.com/runelite-extended/runelite/pulls) for an open or closed Pull Request | ||
that relates to your submission. You don't want to duplicate effort. | ||
* [Fork](https://help.github.com/articles/fork-a-repo/) this repo. | ||
* [Clone](https://help.github.com/articles/cloning-a-repository/) your copy. | ||
```shell | ||
git clone https://github.com/YOUR_USERNAME/runelite.git | ||
cd runelite/ | ||
``` | ||
* After cloning, set a new remote [upstream](https://help.github.com/articles/configuring-a-remote-for-a-fork/) (this helps to keep your fork up to date) | ||
|
||
```shell | ||
git remote add upstream https://github.com/runelite-extended/runelite.git | ||
``` | ||
|
||
* Make your changes in a new git branch: | ||
|
||
```shell | ||
git checkout -b my-fix-branch master | ||
``` | ||
|
||
* Create your patch and run appropriate tests. | ||
* Follow our [Coding Format](#format). | ||
* Commit your changes using a descriptive commit message that uses the imperative, present tense: "change" not "changed" nor "changes". | ||
|
||
```shell | ||
git commit -a | ||
``` | ||
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. | ||
|
||
* Push your branch to GitHub: | ||
|
||
```shell | ||
git push origin my-fix-branch | ||
``` | ||
|
||
In GitHub, send a pull request to `runelite:master`. | ||
If we suggest changes, then: | ||
|
||
* Make the required updates. | ||
* Re-run runelite and make sure any and all tests are still passing. | ||
* Commit your changes to your branch (e.g. `my-fix-branch`). | ||
* Push the changes to your GitHub repository (this will update your Pull Request). | ||
|
||
If the PR gets too outdated we may ask you to rebase and force push to update the PR: | ||
|
||
```shell | ||
git fetch upstream | ||
git rebase upstream/master | ||
git push origin my-fix-branch -f | ||
``` | ||
|
||
That's it! Thank you for your contribution! | ||
#### After your pull request is merged | ||
After your pull request is merged, you can safely delete your branch and pull the changes | ||
from the main (upstream) repository: | ||
* Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: | ||
```shell | ||
git push origin --delete my-fix-branch | ||
``` | ||
* Check out the master branch: | ||
```shell | ||
git checkout master -f | ||
``` | ||
* Delete the local branch: | ||
```shell | ||
git branch -D my-fix-branch | ||
``` | ||
* Update your master with the latest upstream version: | ||
```shell | ||
git pull --ff upstream master | ||
``` | ||
## <a name="format"></a> Coding Format | ||
To ensure consistency throughout the source code, review our [code conventions](https://github.com/runelite/runelite/wiki/Code-Conventions). | ||
[github]: https://github.com/runelite-extended/runelite | ||
[discord]: https://discord.gg/HN5gf3m |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: "\U0001F41B Bug report" | ||
about: Create a report to help us improve | ||
|
||
--- | ||
|
||
Please check if your issue is not a duplicate by [searching existing issues](https://github.com/runelite/runelite/search?type=Issues) | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Click on '....' | ||
3. Scroll down to '....' | ||
4. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Environment (please complete the following information):** | ||
- OS: [e.g. Windows, Ubuntu, macOS] | ||
- RuneLite version: [e.g 1.4.6] | ||
- Launcher version: [e.g 1.5.2] | ||
|
||
**Additional context** | ||
Add any other context about the problem here, e.g. logs. Your client logs can usually be found in | ||
`C:\Users\<your_user_name>\.runelite\logs` on Windows and `~/.runelite/logs` on Linux and macOS. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
--- | ||
name: "\U0001F680 Feature Request" | ||
about: Suggest an idea for this project | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always | ||
frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've | ||
considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,15 @@ | ||
*.jar | ||
target | ||
nbactions.xml | ||
nb-configuration.xml | ||
/nbproject/ | ||
project.properties | ||
*.iml | ||
|
||
.idea/ | ||
dependency-reduced-pom.xml | ||
**/target/* | ||
.project | ||
.settings/ | ||
.classpath | ||
runelite-client/src/main/resources/META-INF/MANIFEST.MF | ||
git | ||
classes/artifacts/client_jar/run.bat | ||
classes/artifacts/client_jar/client.jar | ||
*.jar |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
-Xmx512m |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
language: java | ||
sudo: false | ||
dist: xenial | ||
cache: | ||
directories: | ||
- $HOME/.m2 | ||
jdk: | ||
- openjdk8 | ||
- openjdk11 | ||
install: true | ||
script: ./travis/build.sh |
Oops, something went wrong.