Refactor file layout
[openafs-wiki.git] / archive / contrib.mdwn
1 # OpenAFS-Contrib
2
3 [openafs-contrib][1] on GitHub is a place to collect projects related
4 to OpenAFS. Each project under [openafs-contrib][1] has it's own
5 reposistories. Each reposistory may has a team with read-write access
6 to the separate projects.
7
8 This is done instead of having personal GitHub repos, or static collections of
9 links to make it easier to find projects releated to OpenAFS.  We invite you to
10 use [openafs-contrib][1] for your own projects so that others can reuse them or
11 even improve them.
12
13 ## What can I do?
14
15 Well, if you have some code to share, you could do one of the following:
16
17 1. I have some code which would fit in a repo.
18
19  * ask for membership of a team dedicated to a repo, where your code fits,
20    so you can work directly on it.
21  * fork this repo and send pull-requests so that a member of a team can
22    integrate it
23
24 2. I have some code which would need its own repo
25
26  * ask openafs-contrib to setup a repo and team for you
27
28 3. I have no clue about git and don't want to learn it.
29
30  * This is sad, but alas, just send the code to one of the openafs-contrib
31    maintainers and they'll act as a proxy (hopefully until you learned git).
32
33 ## Communication
34
35 If you have something you like to share, please contact any of the four members
36 of the openafs-contrib-team:
37
38   * Jakob Haufe (sur5r)
39   * Michael Meffie (mmeffie)
40   * Fabrizio Manfredi (thoulen)
41   * Christof Hanke (chanke)
42
43 ## First steps
44
45 Unlike openafs.org, openafs-contrib is not using gerrit, but git directly.
46 Still, many of the documentation at [[GitDevelopers]] still applies.
47
48 However, here things are a bit different:
49
50 As an example this is what I would do when working for afspy:
51
52 1. create your user (here chanke) at github.
53 2. Fork the repository (inside github), you want to contribute to.
54 3. clone it to your machine:  "git clone git@github.com:chanke/afspy.git afspy"
55 4. do some changes
56 5. git push it to your own repo: "git push"
57 6. Send a pull request towards openafs-contrib.
58
59 Of course, when member of a team which owns a repository, you could push
60 to that directly, but it is good practice to first commit stuff to your
61 private repo and then request the pull from openafs-contrib.
62
63
64 [1]: https://github.com/openafs-contrib