Code

Opened 4 years ago

Closed 3 years ago

Last modified 3 years ago

#14401 closed (fixed)

Add a contributing HOWTO page for new contributors

Reported by: gabrielhurley Owned by: gabrielhurley
Component: Documentation Version: master
Severity: Keywords: contributing
Cc: gg Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

There has been repeated talk of consolidating the "community wisdom" and "the spirit of contributing to Django" in a way that's more accessible and to-the-point for new users in a way that the current contributing docs may not be. Most recently Russell mentioned it in this thread:

http://groups.google.com/group/django-developers/browse_frm/thread/9ebc3e57d539d1ff

I would like to put such a page in the official docs together, and to that end I have created a wiki page to serve as the basis for the eventual patch:

http://code.djangoproject.com/wiki/ContributingHowTo

Attachments (3)

14401_contributing_howto.diff (12.7 KB) - added by gabrielhurley 3 years ago.
14401_contributing_howto.2.diff (36.4 KB) - added by gabrielhurley 3 years ago.
contribute.txt (11.2 KB) - added by lukeplant 3 years ago.
re-wrapped to 80 columns

Download all attachments as: .zip

Change History (13)

comment:1 Changed 4 years ago by russellm

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

Accepted on principle; the wiki page looks like a good start on a draft to me.

One activity that dovetails into this is modifying the wiki/reports page to include a better selection of Trac queries matching to useful activities. This document should then reference that page of queries.

comment:2 Changed 4 years ago by gg

  • Cc g@… added

comment:3 Changed 4 years ago by gg

  • Cc gg added; g@… removed

Changed 3 years ago by gabrielhurley

comment:4 Changed 3 years ago by gabrielhurley

  • Has patch set
  • Status changed from new to assigned

I've taken all of the contributions from the wiki page and turned them into a proper patch. The new document would live at /howto/contribute, which I think has a nice ring to it.

comment:5 Changed 3 years ago by russellm

Looks good to me, Gabriel. I also agree that /howto makes sense as a location for this document.

My only comment would be that the patch possibly needs to include a light factor of the existing contribution docs to reduce the significance of the formal triage team. The triage team was an important part of the process a while back, but isn't any more; if we are adding a new, more friendly description of our process, we should ensure that it isn't inconsistent with our other process documentation.

Changed 3 years ago by gabrielhurley

comment:6 Changed 3 years ago by gabrielhurley

Updated patch attached. This one reworks a few small bits of the existing contributing docs to do the following:

  • Replace references to the "triage team" with information about triage by the community where possible.
  • Remove references to the "triage team" altogether where no longer relevant.
  • Encourage greater community participation by rephrasing some of the scarier language about triaging tickets.

I also re-wrapped a number of long lines in the document, which sadly makes it harder to review the changes to the actual text. I apologize for that.

comment:7 Changed 3 years ago by lukeplant

The wrapping in that patch is strange - in many cases the first line of a paragraph is much shorter than it needs to be. And it general it seems to be wrapped to about 70 chars, when our guide says 80.

I've used the Emacs fill-paragraph command to re-wrap all the text in contribute.txt, attached.

Changed 3 years ago by lukeplant

re-wrapped to 80 columns

comment:8 Changed 3 years ago by gabrielhurley

  • Resolution set to fixed
  • Status changed from assigned to closed

In [15645]:

Fixed #14401 -- Added a contributing howto guide for new users. Thank you to everyone who added their advice, feedback, and wisdom to the wiki article while constructing this new guide.

comment:9 Changed 3 years ago by gabrielhurley

In [15646]:

[1.2.X] Fixed #14401 -- Added a contributing howto guide for new users. Thank you to everyone who added their advice, feedback, and wisdom to the wiki article while constructing this new guide.

Backport of [15645] from trunk.

comment:10 Changed 3 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.