cornedriesprong / mingus

Automatically exported from code.google.com/p/mingus
GNU General Public License v3.0
0 stars 0 forks source link

Add developer documentation + guidelines #67

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago
Add a couple of wiki pages describing how to contribute, coding style, unit
tests, organization, etc.

btw. this is the first issue that's automatically being sent to the mailing
list as well, to make it easier to follow the progress. I'll probably do
the same for commits, if this test works out. 

[This will mean that this list will generate more mail though. You can
change the amount of mail you receive under 'How do you want to read this
group?' on the 'Edit my membership' page if it bothers you too much.]

Original issue reported on code.google.com by onderste...@gmail.com on 28 Jun 2009 at 10:00

GoogleCodeExporter commented 9 years ago
A rough out-line:

Contribute
   + Bug reports
       + How and what to submit
   + Request features
       + What (not) to request
       + How to vote
   + Blog posts
       + A tutorial or an introduction or a project you are doing
   + Artwork
   + Packaging/distribution
       + How to keep up to date on releases?
       + How do I notify 
   + Code
       + How to get your code added into mingus.
       + How to help out with everyday work

Coding style:
   + docstrings
   + whitespace
   + function, module and class naming
   + KISS. About built-in datastructures. 
   + Python version guidelines
   + clean, well-documented code

Unit tests:
   + How to run the tests
   + How to add a new testcase
   + How to add a new suite
   + What to test for
   + What if a test fails?

Organization:
   + repository
      + project directory structure
      + tagging
   + mailing list
   + build system
   + commit access (how many included patches/code will be good for project membership)
   + working together; branches

Original comment by Rhijnauwen@gmail.com on 29 Jun 2009 at 1:06