This is a portion of the ongoing reorganization of the Drupal.org handbook.

This is the (substantial) chapter on Contributing Code to the Drupal project. Here's a suggested outline:

# Contributing code

* Help existing code: Patching bugs and features
** Finding issues to work on
** Creating patches
** Submitting patches

* Maintain a Project: Modules, Themes and Installation Profiles

** Getting a CVS account
*** Sandbox policy

** Starting a new project
*** Things to consider
*** Add code to CVS: Step-by-step
**** pages for each client (CLI, Tortoise, CVSGUI, Eclipse, etc.)
*** Create the project on drupal.org
*** Project node
*** Handbook page

** Maintaining a project
*** How to be a good maintainer
*** Managing releases
**** Releases, branches and tags, oh my!
*** Using your HEAD
*** Working with Update Status
*** Step-by-Step
**** section for tasks (new version of your module, new release, etc.)
*** Troubleshooting release problems

** Abandoned Projects
*** How to give a project up
*** How to take over an existing project

This section should incorporate most of the existing handbook pages about these topics, with the exception of the pages that belong in the more CVS-specific "What is CVS and How Drupal Uses It" chapter.

Comments

add1sun’s picture

An issue that discusses some of the flow/info issues with the current setup that may be helpful as we proceed here: http://drupal.org/node/227901

joachim’s picture

Looks good.
Count me in.

(How about a Documentation group on g.d.o so we can use a wiki page to work on this outline?)

add1sun’s picture

That was already discussed on the docs list and decided against. You may want to read up on the docs list discussions/meeting summaries just for a bit more context. The outline was reviewed a number of times but doesn't mean it is set in stone for sure. In particular we didn't get terribly deep with it as we figured that would come out as the work on the content happened. If you have suggestions for revising it, please post them here so we can try to lock down the outline sooner rather than later (not to say it won't be flexible as we move forward but I want to give folks a basic, steady framework to start getting the work done and not spend all our time on the outline rather than the actual content.)

One thing that really needs to happen is to map existing content to the outline so we can see where we have gaps, need to rethink, etc.

http://lists.drupal.org/pipermail/documentation/2008-March/005874.html
http://lists.drupal.org/pipermail/documentation/2008-March/005924.html
http://lists.drupal.org/pipermail/documentation/2008-March/005943.html

joachim’s picture

Ok.
Just as the members of the mailing list say they are 'not forum people', I am not a mailing list person.
I'll edit docs where I see a need, but until there's either a forum or a group, I can't effectively contribute.

add1sun’s picture

taking this a section at a time:

* Help existing code: Patching bugs and features
** Finding issues to work on
- need a new page on how to find issues in the queue to work on, maybe pointing to the issue queue section re: searching,etc.
- links to:
http://drupal.org/bug-bingo
http://drupal.org/contrib-bug-bingo
http://drupal.org/patch/spotlight
http://drupal.org/patch-bingo
http://drupal.org/contrib-patch-bingo

** Creating patches --> http://drupal.org/patch/create
** Submitting patches --> http://drupal.org/patch/submit

add1sun’s picture

Status: Active » Needs work

changing status to indicate work has started but still has a ways to go.

nielsbom’s picture

Component: Misc » Placement and navigation

Changed the component to reflect the new component categorization. See http://drupal.org/node/301443
-nielsbom

add1sun’s picture

First pass at the rest (this is going to require more tweaking as we go along...)

* Maintain a Project: Modules, Themes and Installation Profiles:
- existing pages: http://drupal.org/node/7765 and http://drupal.org/handbook/cvs/projects (REUSE one of these or make a new landing page?)

** Getting a CVS account: http://drupal.org/node/59 (point to policies and guidelines)
*** What is a Sandbox?: NEW PAGE

** Starting a new project: NEW PAGE (outline the steps)
*** Things to consider: NO IDEA :p
*** Add code to CVS: Step-by-step: http://drupal.org/node/100748 and http://drupal.org/handbook/cvs/quickstart and http://drupal.org/node/262432 and http://drupal.org/node/112902
**** pages for each client (CLI, Tortoise, CVSGUI, Eclipse, etc.): Tortoise is the only one with instructions on this right now: http://drupal.org/node/188985
*** Create the project on drupal.org: NEW PAGE (from the others on CVS)
*** Add Project node: NEW PAGE (from the others on CVS)
*** Add Handbook page: NEW PAGE (from the others on CVS)

** Maintaining a project (REUSE one of the 2 main?)
*** How to be a good maintainer: Commit messages: http://drupal.org/node/52287 and http://drupal.org/node/188986
*** ADDED: Controlling CVS access: http://drupal.org/node/63634
*** Managing releases: http://drupal.org/handbook/cvs/releases
**** Releases, branches and tags, oh my!
**** Using your HEAD we are going to have "one true path" (http://groups.drupal.org/node/14944)
**** Working with Update Status: http://drupal.org/node/197584
*** Step-by-Step: NEW PAGE describing what kinds of things you can do then...
**** section for tasks (new version of your module, new release, etc.): taken from the quickstart guides
*** Troubleshooting release problems: http://drupal.org/node/128614 (also refer to FAQ: http://drupal.org/handbook/cvs/faq)

** Abandoned Projects
*** How to give a project up: http://drupal.org/node/22572
*** How to take over an existing project: http://drupal.org/node/251466

Other pages to find a home for:
Maintaining a Drupal module using Git (under the dev/maintaining page): http://drupal.org/node/288873

add1sun’s picture

Title: Contrib Redesign: Contributing code » Getting Involved: Contributing code section work

So the new section exists (http://drupal.org/node/10259) and a first pass (with many to follow I'm sure) at reorganizing is done, except for within the Maintain a Project section. That one will be a bear that takes a while to sort out so work will continue on it....

add1sun’s picture

I've continued reworking this. It doesn't follow the initial outline exactly but I think it makes sense. It still needs more fine-tuning in organization, not to mention new landing pages that need to be fleshed out. The Managing releases section has not been reorganized at all yet, nor the new step-by-step tasks created/broken out. This will happen as part of the overall CVS review/rewrite that needs to happen.

At this point we need to focus on the following to finish this issue out:

The Start a new project section still needs to get broken out (http://drupal.org/handbook/cvs/projects) and the landing page finished.
Incomplete pages:
How to be a good maintainer: http://drupal.org/node/314494
Sandbox maintenance rules: http://drupal.org/node/773 (needs an intro to what a sandbox is and the rules need updated)

We also need to read through and do *lots* of cross-linking to the About CVS section.

MGParisi’s picture

http://drupal.org/handbook/cvs/projects has comments that need to be deleted.
http://drupal.org/node/773 the sandbox description was added from a reference of wikipedia!

That leaves http://drupal.org/node/314494

do we want to list the above references?

joachim’s picture

I don't know how far along a regorganiztion is, but this still needs work I'm afraid.

I just needed to create a new project, and having forgotten most of how to do this, I had to go read it up.

1. http://drupal.org/node/100748 promises a step-by-step guide. But it ducks out when it comes to releases, sending me to:
2. http://drupal.org/handbook/cvs/releases -- this is a general overview. it's heaps of information, which if I'm coming from 'step by step' is total overload and way too much. http://drupal.org/handbook/cvs/quickstart#branch-tag might be better, but that's in the middle of something else.

eliza411’s picture

Component: Placement and navigation » Correction/Clarification
Status: Needs work » Fixed

This has been reworked extensively as a result of the Git migration, and I think it can be safely closed.

Status: Fixed » Closed (fixed)

Automatically closed -- issue fixed for 2 weeks with no activity.