acmeattic-devel team mailing list archive

[Karthik Swaminathan Nagaraj <nkarthiks@xxxxxxxxx>]

Hi,
    Given that this is the first time I am involving myself in a serious
project, here are some questions I had. It also feels better to put it down
in a doc.

   - *Coding style:* Do you use a known standard for formatting code? Could
   you pass on a link to the same. I found these:
Google<http://google-styleguide.googlecode.com/svn/trunk/pyguide.html>,
   PEP8 <http://www.python.org/dev/peps/pep-0008/>
   - *Code reviews:* I advocate the following:
      - Any code *has* to be reviewed by someone else before Commit. (OFC
      all of us are committers). Maybe two reviews in the early stages?
      - Coding style is enforced at this stage
      - Techniques used are reviewed
   - *Unit testing:* Though this is really painful, it would be really great
   to have parts of code that is known to work error-free.
      - I would advocate this right from the first, though it may increase
      the dev time (at least for the important modules)
      - Is there a way to run a check on Python code (similar to
      compilation) to clean syntax bugs? Otherwise, unit tests assert
this esp in
      Python
   - *Documentation:* Document your Classes, methods and variables during
   implementation. A little extra documentation never hurt anyone.
      - The Wiki usually captures the high level documentation and does not
      contain implementation details
      - Some of us might think of magic hacks that work - lets enlighten
      others how that works!

Is there anything that I've missed?

-- 
Karthik