Difference between revisions of "A Translators Guide to Git"
m (→Updating a translation: prefer? like? -- 'like' used) |
|||
| Line 24: | Line 24: | ||
To create a local branch which tracks a branch on the server, use: | To create a local branch which tracks a branch on the server, use: | ||
| − | git checkout -b | + | git checkout -b gramps51 origin/maintenance/gramps51 |
= Updating a translation = | = Updating a translation = | ||
| Line 33: | Line 33: | ||
Checkout the maintenance branch: | Checkout the maintenance branch: | ||
| − | git checkout | + | git checkout gramps51 |
Get the latest changes: | Get the latest changes: | ||
| Line 81: | Line 81: | ||
Create a branch to work in: | Create a branch to work in: | ||
| − | git checkout -b xx | + | git checkout -b xx gramps51 |
Now edit the po file. | Now edit the po file. | ||
| Line 89: | Line 89: | ||
git commit -m 'Update xx translation' | git commit -m 'Update xx translation' | ||
| − | You can update the '' | + | You can update the ''gramps51'' branch at any time. |
| − | git checkout | + | git checkout gramps51 |
git pull | git pull | ||
| − | You rebase your working branch on the '' | + | You rebase your working branch on the ''gramps51'' branch at any time. |
git checkout xx | git checkout xx | ||
| − | git rebase | + | git rebase gramps51 |
When you are ready to make a pull request, push your translation to your fork: | When you are ready to make a pull request, push your translation to your fork: | ||
| Line 106: | Line 106: | ||
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. | 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 " | + | Make sure that you select "gramps51" as the base branch. |
==See also== | ==See also== | ||
Revision as of 21:57, 17 October 2019
Contents
Configuration
Git includes your name and email address in 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 [email protected]: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 basic workflow is simpler, but is only available to developers that have write access to the repository. Otherwise translators should create a pull request. This may also be preferred by translators who are new to Git and would like their contribution checked before it is pushed to the repository.
Basic workflow
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.
Creating a pull request
Fork the Gramps repository in GitHub. 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 you fork:
git remote add myfork [email protected]:<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.
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.
