From 6bcef222b84261aa7b6674e7ead8611e6edb0164 Mon Sep 17 00:00:00 2001 From: Devin Date: Wed, 28 Jun 2017 19:50:25 -0700 Subject: [PATCH 1/2] Add CONTRIBUTING.md [ci skip] --- CONTRIBUTING.md | 120 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000000..82201c31021 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,120 @@ +# Contributing to runelite + +We'd love for you to contribute to our source code and to make runelite even better than it is +today! Here are the guidelines we'd like you to follow: + + - [Question or Problem?](#question) + - [Issues and Bugs](#issue) + - [Submission Guidelines](#submit) + - [Coding Format](#format) + +## Got a Question or Problem? + +If you have questions about how to contribute to runelite, please join our our [Discord](https://discord.gg/mePCs8U) 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][github]. Even better you can submit a Pull Request +with a fix. + +**Please see the [Submission Guidelines](#submit) 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](https://github.com/runelite/runelite/pulls) for an open or closed Pull Request + that relates to your submission. You don't want to duplicate effort. +* 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 rebase master -i +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 + ``` + +## Coding Format + +To ensure consistency throughout the source code, keep these rules in mind as you are working: + +* With the exceptions listed below, we follow the standard Java code conventions: + * Tabs, not spaces. + * Brace placement is always next line. + +[github]: https://github.com/runelite/runelite +[discord]: https://discord.gg/mePCs8U \ No newline at end of file From c53b0f6e9bba2486cd819ac1033294765b954c53 Mon Sep 17 00:00:00 2001 From: Devin Date: Wed, 28 Jun 2017 20:03:09 -0700 Subject: [PATCH 2/2] Update README.md to contain link to CONTRIBUTING.md [ci skip] --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 14b87df13f7..190d7e51be8 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,7 @@ For more information visit the [RuneLite Wiki](https://github.com/runelite/runel Most of Runelite is licensed under the BSD 2-clause license. See the license header in the respective file to be sure. Some of the code, like everything in runescape-client, is automatically generated, and is not licensed. + +## Contribute and Develop + +We've set up a separate document for our [contribution guidelines](https://github.com/runelite/runelite/blob/master/CONTRIBUTING.md). \ No newline at end of file