Skip to content
This repository has been archived by the owner on Apr 8, 2023. It is now read-only.

Latest commit

 

History

History
134 lines (93 loc) · 4.52 KB

CONTRIBUTING.md

File metadata and controls

134 lines (93 loc) · 4.52 KB
Raw

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 for setup instructions, and general tips and tricks.

Here are the guidelines we'd like you to follow:

Got a Question or Problem?

If you have questions about how to contribute to runelite, please join our Discord server.

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. Even better you can submit a Pull Request with a fix.

Please see the Submission Guidelines below.

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 for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

  • Fork this repo.

  • Clone your copy.

    git clone https://github.com/YOUR_USERNAME/runelite.git
cd runelite/

  • After cloning, set a new remote upstream (this helps to keep your fork up to date)

    git remote add upstream https://github.com/open-osrs/runelite.git

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch master

  • Create your patch and run appropriate tests.

  • Follow our Coding Format.

  • Commit your changes using a descriptive commit message that uses the imperative, present tense: "change" not "changed" nor "changes".

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  • Push your branch to GitHub:

    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:

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:

    git push origin --delete my-fix-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Coding Format

To ensure consistency throughout the source code, review our code conventions.