My favorites | Sign in
Project Logo
                
Search
for
Updated Nov 15, 2009 by sgbeal
Labels: Phase-UserDocs, Phase-Implementation, Featured, Topic-Project
Contributing  
Contributing to this project

Contributing to v8-juice

Anyone is welcomed to contribute to this project - just get in touch. Coders, documenters, commentors, code reviewers, bug submitters, etc.... they're all welcomed. Even marketing people and armchair code analysts.

Particular areas where help is currently sought are:

  • Porting the build tree to scons, for platform portability
  • Adding plugins, especially bindings for popular 3rd-party toolkits (e.g. libcurl).

Contributing code

Potential contributors must be willing to follow a very simple set of guidelines:

New code must be documented. The documentation belongs in the header files (e.g. doxygen style). Commenting of implementation code (the .cc or .cpp files) is left to personal judgement and taste - there are no rules. Any function, class, typedef, or macro which is not documented cannot be part of a public API. Internal/private functions/types/macros must also be documented if they are used in more than one implementation file.

(And because of that rule, this library, at one week old, already has more API docs than v8 does.)

Nobody's asking for doctorate-level documentation, but some description of what the code does is a must. The existing API docs are good guideline (though sometimes there's admittedly a bit more documentation than is strictly necessary).

Other than that, i'm pretty much open to anything.

Contributors

So far they include:

  • Stephan Beal is the primary architect and author.
  • Rob Tsuk has contributed several fixes and made a number of suggestions which led to new features or fundamental improvements.
  • The folks at http://groups.google.com/group/v8-users have been very helpful in all things related to v8.


Sign in to add a comment
Hosted by Google Code