Skip to content

Commit 615f428

Browse files
EllieEllie
Ellie
authored and
Ellie
committed
Add contributing guide
1 parent 916adf5 commit 615f428

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

CONTRIBUTING.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contribution Guide
2+
3+
Hello, thank you for your interest in contributing to this project.
4+
5+
In order to add code to this project using git version control, there are a number of steps to take.
6+
This guide will focus on these concepts, if you have further questions feel free to make an issues/MR thread,
7+
join our discord, or ask a mod.
8+
9+
Please join the [OpenRSC discord][discord] and post in the
10+
`#botting-client-development` channel.
11+
12+
---
13+
#### Guide for git:
14+
15+
1. Create a fork of the of the Idlersc project
16+
2. Use git to pull down the master branch from your own remote gitlab repository.
17+
3. Create a new named branch of master and use that branch to develop changes on.
18+
* If Idlersc-master is updated remotely while you are developing changes you will need to rebase before merging.
19+
* Go to your fork of Idlersc in a web browser and click the "update fork" button
20+
* Pull(fast-forward) down the now updated master branch to your local environment.
21+
* Rebase your named dev branch onto the updated local master branch
22+
* Push your updated branch to your remote.
23+
4. When changes are ready to be merged, go to the main Idlersc branch and create a merge request.
24+
* Merge requests are under Code category on the left side bar.
25+
* The source is your named branch and target is Idlersc-master.
26+
27+
---
28+
29+
If you have any more questions, feel free to ask in the discord (linked above).
30+
31+
Thank you, have a great day!
32+
33+
34+
[discord]: https://discord.gg/CutQxDZ8Np

0 commit comments

Comments
 (0)