worg-git.org

   1 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
   2 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
   3 #+TITLE:      How to use git to edit Worg files?
   4 #+AUTHOR:     Worg people
   5 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
   6 #+EMAIL:      bzg AT altern DOT org
   7 #+LANGUAGE:   en
   8 #+PRIORITIES: A C B
   9 #+CATEGORY:   worg
  10 #+OPTIONS:    H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
  11
  12 [[file:index.org][{Back to Worg's index}]]
  13
  14 * What is git?
  15
  16 [[http://git.or.cz][git]] is a fast version control system that lets you collaborate on a project.
  17 For details on how to use git, go and read the [[http://www.kernel.org/pub/software/scm/git/docs/tutorial.html][git tutorial]].  For details on
  18 the public git repository, go and read the [[http://repo.or.cz/about.html][about page]] of
  19 http://repo.or.cz/.
  20
  21 The homepage of the Worg project is here: http://repo.or.cz/w/Worg.git
  22
  23 * The first time you contribute to Worg
  24
  25 1. If you don't have a SSH-key, [[file:worg-git-ssh-key.org][create one]].
  26
  27 2. Register a [[http://repo.or.cz/m/reguser.cgi][new account]] on the git public repository.
  28
  29 3. Drop an email to [[mailto:bzg%20AT%20altern%20DOT%20org][Bastien]] mentioning your username on repo.or.cz
  30
  31 4. Install git on your system.
  32
  33 5. Clone the project somewhere in a working directory:
  34
  35    :~$ git clone git+ssh://repo.or.cz/srv/git/Worg.git
  36
  37 6. Go to the newly created =Worg/= directory and edit some files.
  38
  39 7. If you created files, add them to the git index:
  40
  41    :~$ git add *.org
  42
  43 8. Commit changes with the appropriate ChangeLog:
  44
  45   :~$ git commit -a -m "My changelog"
  46
  47 9. Push your change to Worg:
  48
  49   :~$ git push
  50
  51 * The second time you contribute to Worg
  52
  53 1. Go to your =Worg/= directory.
  54
  55 2. Be sure to "pull" the last version of the repository.
  56
  57 3. Make some changes.
  58
  59 4. Commit your changes on your local repository:
  60
  61    :~$ git commit -a -m "My ChangeLog"
  62
  63 5. Push your change on the remote repository
  64
  65    :~$ git push
  66
  67 * Getting organized
  68
  69 The Worg TODO file is =worg-todo.org=.  If you are a Worg zealot, maybe you
  70 want to add this file to the list of your agenda files.  For example, here
  71 is my =org-agenda-files= variable:
  72
  73   :(setq org-agenda-files '("~/org/bzg.org" "~/git/Worg/worg-todo.org")
  74
  75 I have an agenda custom command for checking tasks that are assigned to me:
  76
  77   :(org-add-agenda-custom-command '("W" tags "Owner=\"Bastien\""))
  78
  79 The next time someone assigns a task for me, it will appear in my Worg
  80 agenda view.
  81
  82 * Register your changes under your name
  83
  84 Information regarding your name is stored in the .gitconfig file, where
  85 you pulled the Worg project.
  86
  87 Edit it like this:
  88
  89 :[user]
  90 :        name = Your Name Goes Here
  91 :        email = you@yourdomain.example.com
  92
  93 Now your changes will be filed under your name.
  94
  95 Alternatively you can add this to ~/.gitconfig which will apply to all
  96 git repositories you have.
  97
  98 # I'm not sure this is useful at all:
  99 * COMMENT Anonymous editing through the "mob" user/branch
 100
 101 If you don't want to register a new account on =repo.or.gz= but still
 102 want to suggest modifications on Worg, you can do this by editing the
 103 "mob" branch of Worg.  For details about the =mob= user, check [[http://repo.or.cz/mob.html][this
 104 webpage]] on repo.or.cz
 105
 106 This branch is usually empty, since interesting changes are quickly
 107 merged into the master branch.  But it is important to make sure that
 108 you pull all changes in any existing =mob= branch before trying to push
 109 yours.
 110
 111 1. Clone the Worg project as the =mob= user:
 112
 113    :~$ git clone git+ssh://mob@repo.or.cz/srv/git/Worg.git
 114
 115 2. Check out the "mob" branch to avoid conflicts between the =mob=
 116    branch that you will soon create and any existing =mob= branch:
 117
 118    :~$ git checkout origin/mob
 119
 120    You should get this warning:
 121
 122    : Note: moving to "origin/mob" which isn't a local branch
 123    : If you want to create a new branch from this checkout, you may do so
 124    : now or later) by using -b with the checkout command again. Example:
 125    : git checkout -b <new_branch_name>
 126
 127    Don't worry.
 128
 129 3. Create a new branch named =mob= from this checkout:
 130
 131    :~$ git checkout -b mob
 132
 133 4. Edit the files, add new files (=git-add=) and commit (=git-commit=)
 134    them as usual.
 135
 136 5. Push the =mob= branch into the Worg remote directory:
 137
 138    :~$ git push origin mob
 139
 140 You're done!
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155 # FIXME:
 156 # What if two people edit Worg at the same time?
 157 # Can I have private sections in Worg?