====== Git Contribution Guidelines ======
===== SSH =====

== for the remote git management you have these two commands: ==

<code bash>
ssh -p 51100 team@git.hyperbola.info   # the team repo
ssh -p 51100 <user>@git.hyperbola.info   # your repo
</code>

<note><user> its your username eg: newcontributor</note>

==== Comands ====

with ssh to team or your repo you can only use 4 commands:
  * "list" is for listing repositories
  * 'description' for adding a description or a title to that repo
  * 'make' to create a repository
  * 'remove' to remove

type the command <color #0B71B9/#DDF1FF>'make'</color> for example
when it says  <color #B90B0B/#FFDDDD>'Please specify the address of the Git repository'</color> its asking for the folder name

for example <color #0B71B9/#DDF1FF>'documentation'</color> is the folder for many repositories like guide.git were i have uploaded my file then it prints Please specify the name of the Git repository:

to create "documentation/guide.git" in the remote repo team or <user>, you cant type: 

<code bash>
guide
</code>

To create folders in your local machine, open your terminal and type as follow:

<code bash>
mkdir GIT && cd GIT && mkdir team && cd team && mkdir documentation && mkdir hyperbolabsd && mkdir packages && mkdir services && mkdir software
</code>

To end up create these folders:

<code bash>
# GIT/team/documentation
# GIT/team/hyperbolabsd
# GIT/team/packages
# GIT/team/services
# GIT/team/software
</code>

===== Cloning repositories =====

Now go to team/packages:

<code bash>
cd packages
</code>

Clone the repositories core and extra:

<code bash>
git clone ssh://<user>@git.hyperbola.info:51100/~git/~team/packages/core.git
git clone ssh://<user>@git.hyperbola.info:51100/~git/~team/packages/extra.git
</code>

===== Create your branch =====

cd (=change directory) into to the extra repository:

<code bash>
cd extra
</code>

And create your own branch in team git:

<code bash>
git branch <user>   # to create a new branch
git checkout <user>   # to switch to your branch
</code>

===== Edit, add and remove files ======

Create the files you want to add to extra repository and type: 

<code bash>
git add .
</code>

<code bash>
git commit -sam "Add your commit comment here"
</code>



<note tip>To push and pull from the team repository make these changes inside team/packages/extra/.git/config </note>

==== Change <user> to your username: ====

<code bash>
[core]
	repositoryformatversion = 0
	filemode = true
	bare = false
	logallrefupdates = true
[remote "origin"]
	url = ssh://<user>@git.hyperbola.info:51100/~git/~team/packages/extra.git
	fetch = +refs/heads/*:refs/remotes/origin/*
        pushurl = ssh://team@git.hyperbola.info:51100/~git/~team/packages/extra.git
[branch "master"]
	remote = origin
	merge = refs/heads/master
[branch "<user>"]
	remote = origin
	merge = refs/heads/<user>
</code>

To push and pull commits type

<code bash>
git push origin <user>   # to push commits to your branch
git pull origin master   # pull commits from the master branch to your branch
</code>

To merge commits from master branch 

<code bash>
git checkout <user>
git merge master
</code>

Then you can push to remote master branch

<code bash>
git push   # to push commits in the current branch
</code>

===== Reverting commits =====

We countinue with more git commands

<code bash>
git reset --soft HEAD~1   # reverts locally your commits ... however it keeps your modifications
git reset --hard HEAD~1   # reverts and removes your latest commit change
git reset --hard HEAD~2   # if you have plans to remove more commits (2 in this case), if you didn't push those commits remotely
git format-patch -1   # generates a patch of the latest commit
git revert $commit_checksum   # the best way to avoid piss off the work of the other members
</code>

If you would revert this commit -> https://git.hyperbola.info:50100/packages/extra.git/commit/?id=85b468a2c03371c4e3550a0ddc529a9df376e6ae

you should run:

<code bash>
git revert 85b468a2c03371c4e3550a0ddc529a9df376e6ae
</code>

<note>It will generate a new commit by reverting your commit.</note>

If it comes from your own branch (not in master, please!) you could run:

<code bash>
git reset --hard HEAD~1   # (for the latest commit) or:
git reset --hard HEAD~2   # (for the latest 2 commits), then you could run:
git push --force
</code>

===== Rebasing codebase =====

However, please don't use this command in master, for that reason i'm insisting for each user to create their own branches.

<code bash>
git checkout master   # to pull changes from your branch to master, then:
git pull --rebase origin <user>
git push origin master && git push origin <user>   # to push them (in your case)
</code>

===== Pushing changes =====

Remember to push those commits to master and milky-way-v0.4 branches if you consider those ones stable and tested by you first because I will pull them to our build server to build and push to repos.
You have your own user repo to make experimental things there.  You could use forced commands such as:

<code bash>
git push --force   # because it is in fact your own personal repo for experimental reasons.
</code>

====== Conclusion ======

So, in short, you have 2 ways to push your commits:
  * your own repo for experimental reasons and then,
  * branches for testing

=== Aknowlegments ===
Hyperbola Development Team git repository use:
Copyright 2021 rachad
Copyright 2021 André Silva
Copyright 2021 Quiliro Ordóñez
GNU Free Documentation License