-
Patrick Barroca authoredb162cec5
Contribute to source code
Content
- Prerequisite
- Create your own copy of the project
- How to contribute to the source code
- Create a new skin
Prerequisite
AFI & BIBLIBRE developpment teams use the opensource forge libre GitLab and theSCM Git. Ce document décrit l'utilisation minimale nécessaire de ces deux outils pour pouvoir contribuer au code des projets maintenus par AFI et Biblibre. Néanmoins nous vous invitons à lire le livre Pro Git.
Source code are hosted on https://git.afi-sa.fr. Public projects are accessible here https://git.afi-sa.fr/public.
Create your own copy of the project
Create a gitlab account
From the Sign Up page, you can create your account. You will receive a confirmation email.
Clone the project
Once connected, from the OPACCE project page, clic on the Fork repository button. You can also clone the project here.
This will create your own public copy of the project accessible through http://git.afi-sa.fr/my-account/opacce.
The SSH access is given from your project home page. for example git@git.afi-sa.fr:my_account/opacce.git
Installing SSH access
In order to upload modifications on the gitlab you need SSH access. On Your account page, in the SSH Keys tab, use the link Add SSH Key.
Create & register your key
If you already have a key on your workstation in ~/.ssh/id_rsa.pub, copy it.
otherwise, generate a key , with the following command:
ssh-keygen -t rsa -C "addresse_email@domaine.ext"
to show the content:
cat ~/.ssh/id_rsa.pub
configure SSH access
SS access uses 2950 port. Create or modify the ~/.ssh/config file to add the following lines:
Host git.afi-sa.fr
Hostname git.afi-sa.fr
Port 2950
User git
IdentityFile ~/.ssh/id_rsa
How to contribute to the source code
Install your own copy of the project
The install process is described Installation instructions, unlike described in the Downloading source code section, you should use your own depository:
cd /var/www
git clone git@git.afi-sa.fr:mon_compte/opacce.git
Update files and push them to gitlab
Once your done with your udpates, the file upload is done in two steps.
- Commit your modifications locally
git commit -a -m "Commentaires des modifications"
- Push your master branch to gitlab (origin):
git push origin master
For more details please check Pro Git
Propose patches to the release team
On your private GitLab page, Merge Requests tab, clic on the link + New Merge Request and fill the form to describe your patch.
retrieve the last official release
Declate the official version depository (upstream) in your local project:
git remote add upstream git@git.afi-sa.fr:afi/opacce.git
Merge modifications:
# Download all modification from the master project
git fetch upstream master
# Merge the modifications in your local project
git merge upstream/master
# Push the result on the depository
git push origin master
Create a new skin
Create
Go to the skin directory in the root folder and duplicate it
cd skins
cp -a ../public/opac/skins/modele mon_skin
Go the the profil config page in the opac back office, you should see your skin in the combo.
Save you skin on GitLab
Create a project on GitLab to store the sourcecode. For exemple https://git.afi-sa.fr/mon_compte/mon_skin.
Go to my_skin and initialise the depository: