Prettified the parameter layout of workerqueue (#5397)

[friendica.git] / doc / Github.md

diff --git a/doc/Github.md b/doc/Github.md
index cfdb014764fc9e2b088c166725df82c238903293..ca467e525440d542717ea31712d2885dd5c40ff2 100644 (file)
--- a/doc/Github.md
+++ b/doc/Github.md
@@ -1,25 +1,26 @@
-Friendica on Github
+Friendica on GitHub

 ===================
 
 * [Home](help)
 
 Here is how you can work on the code with us. If you have any questions please write to the Friendica developers' forum.
 
 ===================
 
 * [Home](help)
 
 Here is how you can work on the code with us. If you have any questions please write to the Friendica developers' forum.
 

-Introduction to the workflow with our Github repository
+Introduction to the workflow with our GitHub repository

 -------------------------------------------------------
 
 1. Install git on the system you will be developing on.
 -------------------------------------------------------
 
 1. Install git on the system you will be developing on.

-2. Create your own [github](https://github.com) account.
+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).
 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.
+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. Run `bin/composer.phar install` in Friendica's folder.
+6. Commit your changes to your fork.
+Then go to your GitHub page and create a "Pull request" to notify us to merge your work.

 
 Our Git Branches
 ----------------
 
 
 Our Git Branches
 ----------------
 

-There are two relevant branches in the main repo on Github:
+There are two relevant branches in the main repo on GitHub:

 
 1. master: This branch contains stable releases only.
 2. develop: This branch contains the latest code.
 
 1. master: This branch contains stable releases only.
 2. develop: This branch contains the latest code.


@@ -66,5 +67,10 @@ Don't assume that a simple fix won't break anything else.
 If possible get an experienced Friendica developer to review the code.
 Don't hesitate to ask us in case of doubt.
 
 If possible get an experienced Friendica developer to review the code.
 Don't hesitate to ask us in case of doubt.
 

+3. Check your code for typos.
+There is a console command called *typo* for this.
+
+       $> php bin/console.php typo
+

 Check out how to work with [our Vagrant](help/Vagrant) to save a lot of setup time!
 
 Check out how to work with [our Vagrant](help/Vagrant) to save a lot of setup time!