New Coding Styles Doc

 
From: "Dada Mail" <dada@PROTECTED>
In-Reply-To: regarding CVS conflicts
Date: July 25th 2005

I quickly put together some coding style docs up in the "developers"
directory in CVS It'll show up in a few hours here:

 http://cvs
sourceforge
net/viewcvs
py/mojomail/dada_mail_stable/

dada/extras/developers/

And I've copied it below - only a skeleton at the moment:

NAME Programming Code Styling for Dada Mail!

DESCRIPTION This document is to help in understanding how Dada Mail is
written =pod

Perl All code must run under the -T (taint) flag

xHTML Must be valid

CSS Must be valid

Javascript

Commenting Code Several proposed labels have been put into place - all are Optional

 * DEV or DEVELOPER or DEVCOMMENT (let's figger it out!)
     Notes to other developers, explaining why something is done

the way it is - shouldn't be used for EVERY darn comment, but only
when the reason can't be explained in say, a sentence Example:

      # DEV
      # archive, archive_rss and archive_atom
      # form:
      #/archive/justin/20050422012839/

     This should not replace any inline POD, as POD can be

grokked to make documentation 

 * HACK
     Used to denote that a particular coding style isn't

something that should be followed, but works on the current situation 

 * TODO
     Marks an area that needs work

CVS When comitting via CVS and you're working on a bug/feature request, please put the id of the bug feature request in the comment of the commit 

 Any other ideas are appreciated
 I'd rather have TOO MUCH

commenting going on than too little

Cheers,

Justin Simoni

rss/atom
‹ regarding CVS conflicts
Index
regarding additional CSS classes ›
  • This mailing list is a public mailing list - anyone may join or leave, at any time.
  • This mailing list is a group discussion list (unmoderated)

  • Start a new thread, email: dadadev@dadamailproject.com

This is the developer discussion mailing list for Dada Mail.

If you are just looking for support Dada Mail, consult the message boards at:

https://forum.dadamailproject.com

Documentation for Dada Mail:

https://dadamailproject.com/d

Specifically, see the Error FAQ:

https://dadamailproject.com/d/FAQ-errors.pod.html

To post to this list, send a message to:

mailto:dadadev@dadamailproject.com

All subscribers of this list may post to the list itself.

Topics that are welcome:

  • Constructive critiques on the program (I like, "x", but, "y" needs some work - here's an idea on how to make this better...)
  • Bug/Error reports
  • Bug fixes
  • Request For Comments on any changes to the program
  • Help customizing Dada Mail for your own needs
  • Patches
  • Language Translations
  • Support Documentation/Doc editing, FAQ's, etc.
  • Discussion of any changes that you would like to be committed to the next version of Dada Mail -

Dada Mail is on Github:

https://github.com/justingit/dada-mail/

If you would like to fork, branch, send over PRs, open up issues, etc.

Privacy Policy:

This Privacy Policy is for this mailing list, and this mailing list only.

Email addresses collection through this mailing list are used explicitly to work within this email discussion list.

We only collect email addresses through our Closed-Loop Opt-In system.

We don't use your email address for any other purpose.

We won't be sharing your email address with any other entity.

Unsubscription can be done at any time. Please contact us at: justin@dadamailproject.com for any help regarding your subscription, including removal from the mailing list.

All mailing list messages sent from us will include a subscription removal link, which will allow you to remove yourself from this mailing list automatically, and permanently.

All consent to use your email address for any other purpose stated at the time of the mailing list subscription will also be revoked upon mailing list removal.