Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision | ||
en:uhsdr_dev:git [02.03.2018 13:16] – df9ts_user | en:uhsdr_dev:git [13.03.2018 13:25] – df9ts_user | ||
---|---|---|---|
Line 13: | Line 13: | ||
* If using Eclipse: create a work space pointing at the local directory where UHSDR has been unpacked. Check Eclipse settings after that (active build etc.) | * If using Eclipse: create a work space pointing at the local directory where UHSDR has been unpacked. Check Eclipse settings after that (active build etc.) | ||
- | ==== Option: Use " | + | ==== Option: Use " |
+ | |||
+ | === Fork UHSDR to your own remote github repo === | ||
+ | * Create github account if needed, or sign into github | ||
+ | * Goto https:// | ||
+ | * Note the URL of your github fork, e.g. https:// | ||
=== Pull UHSDR from Github === | === Pull UHSDR from Github === | ||
* If git is not intalled on your system: < | * If git is not intalled on your system: < | ||
- | * Clone UHSDR repository: | + | * Clone UHSDR repository: Go to the directory where you want to store the GIT clone, then create a local clone. Use the URL for your github fork, e.g. < |
- | * Go to the directory where you want to store the GIT clone, then type< | + | * You now have a local clone of your fork in the current local directory |
+ | * Check the remote repos assigned < | ||
+ | * Add DF8OE UHSD repo as upstream remote repo so that you can esaly synch it with your fork: < | ||
+ | * Check with "git remote -v" that upstream has been added. You now have two remote repos: " | ||
+ | |||
+ | === Rebase: Synchronising your fork with UHSDR DF8OE repo === | ||
+ | * You want to synchronise your forked UHSDR with the DF8OE main repo from time to time to include the latest changes of UHSDR into your fork. | ||
+ | * For that use < | ||
+ | * Your local fork is now synchronised with UHSDR DF8OE repo | ||
+ | * Next you need to push these changes to your remote github repo < | ||
+ | * Your github fork is now synchronised with DF8OE UHSDR main repo | ||
+ | |||
+ | === Creating branches for tests and experiments === | ||
+ | Before creating any new branch please pull the changes from upstream as explained above. Make sure your forked repo is up to date. | ||
+ | |||
+ | * Create the branch on your local machine and switch in this branch :< | ||
+ | * Change working branch : < | ||
+ | * Push the branch from local repo onto remote github : < | ||
+ | * When you want to commit something in your branch, be sure to be in your branch. Add -u parameter to set upstream. To check current branch use < | ||
+ | * Add a new remote for your branch : < | ||
+ | * Push changes from your commit into your branch : < | ||
+ | * Update your branch when the original branch from official repository has been updated : < | ||
+ | * Then you need to apply to merge changes, if your branch is derivated from develop you need to do : < | ||
+ | * Delete a branch on your local filesystem : < | ||
+ | * To force the deletion of local branch on your filesystem : < | ||
+ | * Delete the branch on github : < | ||
=== Use local UHSDR clone in Eclipse === | === Use local UHSDR clone in Eclipse === | ||
Line 35: | Line 65: | ||
* Hit " | * Hit " | ||
- | ==== Rebase ==== | + | ==== Contributing, |
- | you should NOT use merge/pull to integrate changes | + | The heart of any open source project is the contributions by individuals. Source code for the project is using git currently and can be found [[https:// |
+ | |||
+ | We have specific instructions for contributors collected in [[https:// | ||
+ | |||
+ | For own developments and experiments in code you should | ||
+ | use git " | ||
+ | We had very little trouble to follow that approach for the last two years. It also has its issues but in general, once you understand how to operate it, it works quite well. The main benefit of the rebase approach is that it keeps all your " | ||
+ | |||
+ | ==== Further reading ==== | ||
+ | https:// | ||