X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=doc%2FGithub.md;h=ca467e525440d542717ea31712d2885dd5c40ff2;hb=51a58ec2e2014cab48140a22ec2c42b233f1ec61;hp=d83c295fc610e919d1d0e48d835de59fadd8440c;hpb=6fdc524eee470fa0b9418ed9760313ae441dcd56;p=friendica.git diff --git a/doc/Github.md b/doc/Github.md index d83c295fc6..ca467e5254 100644 --- 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. -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. -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). -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 ---------------- -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. @@ -67,7 +68,9 @@ 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 PHP script in the *util* directory called *typos.php* for this. +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!