contrib.mdwn

   1 # Community contributions
   2
   3 Many people have written a lot of scripts to make daily chores easier.<br/>
   4 Here, we'd like to gather them, so that it is easy to look them up.
   5
   6 ## code stored on github
   7
   8 Instead of having a static collection of links or source-code, we <br/>
   9 created a repository to github and invite you to use it for your own scripts<br/>
  10 so that others can reuse them or even improve them.
  11
  12 For this, we created an organizatorial user openafs-contrib on github.com :
  13
  14 <https://github.com/openafs-contrib>
  15
  16 There, we can host different repositories for different needs.<br/>
  17 The idea is that each project can have its own repositories.<br/>
  18 To each repository, there is a team with RW access.
  19
  20 So far there is :
  21
  22  * [afspy](https://github.com/openafs-contrib/afspy) (python-bindings to afs as introduced at the EAKC 2011 https://indico.desy.de/getFile.py/access?contribId=10&sessionId=7&resId=0&materialId=slides&confId=4756)
  23  * [misc](https://github.com/openafs-contrib/misc) (unsorted)
  24
  25 ## What can I do ?
  26
  27 Well, if you have some code to share, you could do one of the following :
  28
  29 1. I have some code which would fit in a repo :
  30  * ask for membership of a team dedicated to a repo, where your code fits, so you can work directly on it.
  31  * fork this repo and send pull-requests so that a member of a team can integrate it
  32
  33 2. I have some code which would need its own repo
  34  * ask openafs-contrib to setup a repo and team for you
  35
  36 3. I have no clue about git and don't want to learn it.
  37  * This is sad, but alas, just send the code to one of the openafs-contrib maintainers and they'll
  38    act as a proxy (hopefully until you learned git).
  39
  40
  41 ## Communication
  42
  43 We should communicate through a mailing-list, but this has to be setup.
  44
  45 If you have something you like to share, please
  46 contact any of the four members of the openafs-contrib-team :
  47
  48 * Jakob Haufe  (sur5r)
  49 * Michael Meffie (mmeffie)
  50 * Fabrizio Manfredi (thoulen)
  51 * Christof Hanke (chanke)
  52
  53
  54 ## first steps
  55
  56 Unlike openafs.org, openafs-contrib is not using gerrit, but git directly.
  57 Still, many of the documentation at [[GitDevelopers]] still applies.
  58
  59 However, here things are a bit different:
  60
  61 As an example this is what I would do when working for afspy :
  62
  63 1. create your user (here chanke) at github.
  64 2. Fork the repository (inside github), you want to contribute to.
  65 3. clone it to your machine:  "git clone git@github.com:chanke/afspy.git afspy"
  66 4. do some changes
  67 5. git push it to your own repo: "git push"
  68 6. Send a pull request towards openafs-contrib.
  69
  70 Of course, when member of a team which owns a repository, you could push
  71 to that directly, but it is good practice to first commit stuff to your
  72 private repo and then request the pull from openafs-contrib.
  73
  74
  75 ## To-do :
  76
  77 * setup mailing list
  78 * setup email-notifications
  79 * make this page more better