Skip to content

Commit

Permalink
Updates the CONTRIBUTING guide
Browse files Browse the repository at this point in the history
  • Loading branch information
@Cleako
Cleako committed Feb 27, 2019
1 parent a1ea48f commit e4d5a27
Showing 1 changed file with 21 additions and 23 deletions.
44 changes: 21 additions & 23 deletions CONTRIBUTING.md
View file
Expand Up @@ -6,7 +6,7 @@ today! Here are the guidelines we'd like you to follow:
* [Code of Conduct](#coc)
* [Issues and Bugs](#issue)
* [Issue Submission Guidelines](#submit)
* [Pull Request Submission Guidelines](#submit-pr)
* [Merge Request Submission Guidelines](#submit-pr)
* [Suggested Developer Software](#software)
* [Developer Installation Process](#install)
* [Before You Start](#pre)
Expand All @@ -15,19 +15,19 @@ today! Here are the guidelines we'd like you to follow:

## <a name="coc"></a> Code of Conduct

Help us keep Open RSC both open and inclusive. Please read and follow our [Code of Conduct](https://github.com/open-rsc/Game/blob/2.0.0/CODE_OF_CONDUCT.md).
Help us keep Open RSC both open and inclusive. Please read and follow our [Code of Conduct](https://gitlab.openrsc.com/open-rsc/Game/blob/2.0.0/CODE_OF_CONDUCT.md).

## <a name="issue"></a> Found an Issue or Bug?

If you find a bug in the source code, you can help us by submitting an issue to our
[GitHub Repository](https://github.com/open-rsc/Game). Even better, you can submit a Pull Request with a fix.
[GitLab Repository](https://gitlab.openrsc.com/open-rsc/Game). Even better, you can submit a Pull Request with a fix.

**Please see the [Submission Guidelines](#submit) below.**

## <a name="submit"></a> Issue Submission Guidelines
Before you submit your issue search the archive, maybe your question or bug report was already answered.

The "[new issue](https://github.com/open-rsc/Game/issues/new/choose)" form contains a number of prompts that you should fill out to
The "[new issue](https://gitlab.openrsc.com/open-rsc/Game/issues)" form contains a number of prompts that you should fill out to
make it easier to understand and categorize the issue.

In general, providing the following information will increase the chances of your issue being dealt
Expand All @@ -40,10 +40,10 @@ with quickly:
* **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)

## <a name="submit-pr"></a> Pull Request Submission Guidelines
Before you submit your pull request consider the following guidelines:
## <a name="submit-pr"></a> Merge Request Submission Guidelines
Before you submit your merge request consider the following guidelines:

* Search [GitHub](https://github.com/open-rsc/game/pulls) for an open or closed Pull Request
* Search [GitLab](https://gitlab.openrsc.com/open-rsc/Game/merge_requests) for an open or closed Merge Request
that relates to your submission. You don't want to duplicate effort.
* Create the [development environment](#install)
* Make your changes in a new git branch:
Expand All @@ -60,24 +60,20 @@ Before you submit your pull request consider the following guidelines:
```
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.

* Push your branch to GitHub:
* Push your branch to GitLab:

```shell
git push origin my-fix-branch
```

* In GitHub, send a pull request to `Game:2.0.0`. This will trigger the check of the Travis integration.
* In GitLab, send a merge request to `Game:2.0.0`.

* If you find that the Travis integration has failed, look into the logs on Travis to find out
if your changes caused test failures, the commit message was malformed etc. If you find that the
tests failed or times out for unrelated reasons, you can ping a team member so that the build can be
restarted.

* If we suggest changes, then:

* Make the required updates.
* Commit your changes to your branch (e.g. `my-fix-branch`).
* Push the changes to your GitHub repository (this will update your Pull Request).
* Push the changes to your GitLab repository (this will update your Merge Request).

You can also amend the initial commits and force push them to the branch.

Expand All @@ -86,15 +82,15 @@ restarted.
git push origin my-fix-branch -f
```

This is generally easier to follow, but separate commits are useful if the Pull Request contains
This is generally easier to follow, but separate commits are useful if the Merge Request contains
iterations that might be interesting to see side-by-side.

#### After your pull request is merged
#### After your merge request is merged

After your pull request is merged, you can safely delete your branch and pull the changes
After your merge request is merged, you can safely delete your branch and merge 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:
* Delete the remote branch on GitLab either through the GitLab web UI or your local shell as follows:

```shell
git push origin --delete my-fix-branch
Expand Down Expand Up @@ -124,21 +120,23 @@ from the main (upstream) repository:

**Git Kraken** https://www.gitkraken.com/download

**Atom Editor** https://atom.io
**Visual Studio Code** https://code.visualstudio.com/

**Sublime Text Editor** https://www.sublimetext.com/

## <a name="install"></a> Developer Installation Process

You will need to either use the set up script for Windows or Linux/Mac that comes in the repository or do it all manually.

If you choose to install everything manually and not use the set up scripts, the following are required to be installed to ensure we are all using the same development environment tools:

**MariaDB**, **OpenJDK 11**, **PHPMyAdmin**, **Nginx** or **Apache web server**, **PHP 7.2+**, **Git Kraken** or **git**
**MariaDB**, **OpenJDK 11**, **PHPMyAdmin**, **NGINX** or **Apache web server**, **PHP 7.2+**, **Git Kraken** or **git**

## <a name="pre"></a> Before You Start:

1. Download RSC+ to use for replaying authentic content: https://github.com/OrN/rscplus
2. Clone the Game repo and set up as you wish: https://github.com/Open-RSC/Game
3. Download any replays you need: https://github.com/Open-RSC/RSC-Plus-Replays
2. Clone the Game repo and set up as you wish: https://gitlab.openrsc.com/open-rsc/Game
3. Download any replays you need: https://gitlab.openrsc.com/open-rsc/RSC-Plus-Replays

## <a name="standards"></a> Code Standards:

Expand All @@ -149,4 +147,4 @@ If you choose to install everything manually and not use the set up scripts, the

## <a name="manual"></a> Manual Install Script for Ubuntu Linux by Christofosho:

https://raw.githubusercontent.com/Open-RSC/Game/2.0.0/scripts/Installing-ORSC.txt
https://gitlab.openrsc.com/open-rsc/Game/blob/2.0.0/scripts/archived/Installing-ORSC.txt

0 comments on commit e4d5a27

Please sign in to comment.