From 47884419fb8665e440b55e1cbef26fd61928864a Mon Sep 17 00:00:00 2001 From: CharlesVaneenoo Date: Mon, 29 Feb 2016 16:03:25 +0100 Subject: [PATCH] Create initial contributors guidelines --- CONTRIBUTING.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..6be6cda2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,49 @@ +# Contributing to Apollo + +First off, thanks for taking the time to contribute! +Apollo is a high-performance, modular RuneScape emulator with a collection of utilities for managing data files and plugins. +The following is a set of guidelines for contributing to Apollo on GitHub. + +* [Forking](#forking) +* [Submission Guidelines](#submit) + * [Submitting an Issue](#submit-issue) + * [Submitting a Pull Request](#submit-pull-request) +* [Coding Style](#coding-style) +* [Got a Question or Problem](#got-a-question-or-problem) + +## Forking +You should fork the repository first. This step is needed only once. See complete help in github +`git clone https://github.com/apollo-rsps/apollo.git` +`cd apollo` +`git remote add upstream https://github.com/apollo-rsps/apollo.git` +`git fetch upstream` + +Keep your fork up to date, pull in upstream changes: +`git fetch upstream` +`git merge upstream/master` + +## Submission Guidelines +### Submitting an Issue + +Before you submit your issue search the archive, maybe your question was already answered. +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 +Run all the tests to assure nothing else was accidentally broken. + +- Create a new branch: `git branch ` +- Switch to the new branch: `git checkout ` +- Add your change: `git add ` +- Comment your change: `git commit -m "my-PR-comment"` +- Push your branch to GitHub: `git push -u origin ` + +If you need to rebase your branch, The git book has a very good guide on doing this (and some more information about rebasing), which you can find [here](https://git-scm.com/book/en/v2/Git-Branching-Rebasing). +## Coding Style + +Please follow the [Java styleguides](http://www.oracle.com/technetwork/java/codeconvtoc-136057.html) or [Ruby styleGuides](http://api.rubyonrails.org). + +## Got a Question or Problem? + +Most discussion related to the development of Apollo happens on the IRC channel #apollorsps on irc.freenode.net. +Please contact us if you need help!