A Translators Guide to Git
Git is a distributed control version system, and it is widely used for maintaining source code in opensource software projects like Gramps. Git can track changes to any text file (not only source code), so may be used also to maintain text-based translation files.
Thanks for your interest in helping translate Gramps.
Contents
Install Git
Download and install Git for your operating system from:
Configuration of Git
You will need to Configure Git so that Git includes your name and email address in the Git messages known as commits.
To configure them, use the following commands:
git config --global user.name "John Smith" git config --global user.email [email protected]
Git will automatically convert line endings for you. Use the following settings:
git config --global core.autocrlf true # Windows git config --global core.autocrlf input # Linux/Mac
The following configuration option simplifies pushing a branch back to the server:
git config --global push.default upstream
Obtain a copy of the repository
Clone the repository:
git clone https://github.com/gramps-project/gramps.git Gramps
Change directory:
cd Gramps
Create a maintenance branch
To create a local branch which tracks a branch on the server, use:
git checkout -b gramps51 origin/maintenance/gramps51
Updating a translation
There are two main workflows. The recommend one is that translators should create a pull request, for those translators new to Git and this will allow their contribution to be checked before it is pushed to the repository. The other is the simple workflow for developers, but is only available to developers that have write access to the repository, otherwise please create a pull request.
Creating a pull request
You first need to make a copy of the Gramps repository in GitHub this is referred to as creating a Fork. To do this, go to the Gramps repository page,
https://github.com/gramps-project/gramps
then login, and click on the "Fork" button.
Create a remote to access your Fork:
git remote add myfork https://github.com/<username>/gramps.git
where <username> is you GitHub username.
Create a branch to work in:
git checkout -b xx gramps51
Now edit the po file using your favorite method and once complete.
Commit your changes:
git add po/xx.po git commit -m 'Update xx translation'
You can update the gramps51 branch at any time.
git checkout gramps51 git pull
You rebase your working branch on the gramps51 branch at any time.
git checkout xx git rebase gramps51
When you are ready to make a pull request, push your translation to your fork:
git push myfork xx
Now create a pull request within GitHub.
If you have recently pushed a branch to your fork, then GitHub will highlight this when you visit the repository page, and give you an option to create a pull request. Otherwise click on the "New pull request" button.
Make sure that you select "gramps51" as the base branch.
Simple workflow for developers
This simple workflow is for developers, that have write access to the repository, otherwise please create a pull request.
Checkout the maintenance branch:
git checkout gramps51
Get the latest changes:
git pull --rebase
Now edit the po file.
Check status and differences:
git status git diff
Stage the file for commit:
git add po/xx.po
Commit the change:
git commit -m 'Update xx translation'
Get the latest changes again:
git pull --rebase
Always use the '--rebase' option.
Check the log:
git log
Check using a graphical tool:
gitk
Look for anything unusual such as merge commits.
When you are completely happy, push the changes to the server. If in doubt, don't.
