From 9c2e7a0c5c9a523ba008e68745e28c2e73b34e88 Mon Sep 17 00:00:00 2001 From: Silke Meyer Date: Sun, 28 Dec 2014 16:39:19 +0100 Subject: [PATCH] renamed general dev documentation to github documentation --- doc/Developers.md | 23 ----------------------- doc/Github.md | 25 +++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 23 deletions(-) delete mode 100644 doc/Developers.md create mode 100644 doc/Github.md diff --git a/doc/Developers.md b/doc/Developers.md deleted file mode 100644 index b0fce47b52..0000000000 --- a/doc/Developers.md +++ /dev/null @@ -1,23 +0,0 @@ -Friendica Developer Guide -=================== - -**Here is how you can join us.** - -First, get yourself a working git package on the system where you will be -doing development. - -Create your own github account. - -You may fork/clone the Friendica repository from [https://github.com/friendica/friendica.git](https://github.com/friendica/friendica.git). - -Follow the instructions provided here: [http://help.github.com/fork-a-repo/](http://help.github.com/fork-a-repo/) -to create and use your own tracking fork on github - -Then go to your github page and create a "Pull request" when you are ready -to notify us to merge your work. - -**Important** - -Please pull in any changes from the project repository and merge them with your work **before** issuing a pull request. We reserve the right to reject any patch which results in a large number of merge conflicts. This is especially true in the case of language translations - where we may not be able to understand the subtle differences between conflicting versions. - -Also - **test your changes**. Don't assume that a simple fix won't break something else. If possible get an experienced Friendica developer to review the code. \ No newline at end of file diff --git a/doc/Github.md b/doc/Github.md new file mode 100644 index 0000000000..918dee1ffb --- /dev/null +++ b/doc/Github.md @@ -0,0 +1,25 @@ +Friendica on Github +=================== + +* [Home](help) + +**Here is how you can work on the code with us** + +1. Install git on the system you will be developing on. +2. Create your own [github](https://github.com) account. +3. Fork the Friendica repository from [https://github.com/friendica/friendica.git](https://github.com/friendica/friendica.git). +4. Clone your fork from your Github account to your machine. Follow the instructions provided here: [http://help.github.com/fork-a-repo/](http://help.github.com/fork-a-repo/) to create and use your own tracking fork on github +5. Commit your changes to your fork. Then go to your github page and create a "Pull request" to notify us to merge your work. + +**Branches** + +There are two branches in the main repo on Github: + +1. master: This branch contains stable releases only. +2. develop: This branch contains the latest code. This is what you want to work with. + +**Important** + +Please pull in any changes from the project repository and merge them with your work **before** issuing a pull request. We reserve the right to reject any patch which results in a large number of merge conflicts. This is especially true in the case of language translations - where we may not be able to understand the subtle differences between conflicting versions. + +Also - **test your changes**. Don't assume that a simple fix won't break something else. If possible get an experienced Friendica developer to review the code.