threads / discuss / 28333

Make it easier for new contributors to come to grips with the project

Subject: Make it easier for new contributors to come to grips with the project

## tl;dr

2 messages between Sep 8, 2011 and Sep 8, 2011.

replies: 1people: 1as markdown or json

Andrew Ardill· Sep 8, 2011, 06:47 UTC · lore

Something that has been difficult as a developer looking to contribute to this project is trying to understand how everything is organised.

In particular, working out what 'pu' stood for took quite a long time.

Following is a (very) simple patch to the README that will at least send potential contributors off in a useful direction. I know I would have saved much time if this note was there when I started looking.

Potentially, the wiki and public website could be updated to provide similar links and start-up hints.

Andrew Ardill· Sep 8, 2011, 07:45 UTC · re: Andrew Ardill · lore

[PATCH] Add a note to the README for new contributors

Signed-off-by: Andrew Ardill <andrew.ardill@gmail.com>
---
 README |    4 ++++
 1 files changed, 4 insertions(+), 0 deletions(-)

diff --git a/README b/README
index 67cfeb2..b67a881 100644
--- a/README
+++ b/README
@@ -52,3 +52,7 @@ git.git (stable)" and "What's cooking in git.git (topics)" and
 the discussion following them on the mailing list give a good
 reference for project status, development direction and
 remaining tasks.
+
+If you are looking to contribute to the project, a good place to start
+is http://git-blame.blogspot.com/p/note-from-maintainer.html and in
+Documentation/howto/maintain-git.txt

-- 
1.7.6.msysgit.0