Difference between revisions of "Platform Developer Communication"

From Sirikata Wiki
Jump to navigation Jump to search
m
(Change link to bug database)
 
(13 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 
Developers stay in touch via a number of mechanisms
 
Developers stay in touch via a number of mechanisms
  
 
=== Mailing List ===  
 
=== Mailing List ===  
  
The [http://groups.google.com/group/platformtalk Developer List] is open for all to join and our [http://groups.google.com/group/platformtalk/topics archives] are public. Use for discussion about the platform architecture, protocols, and implementations. Patch sets can also be sent to this list for review and application if you do not have core commit access. We don't specifically separate mailing list traffic for application and platform developers since the overlap is significant and often useful, but we'd prefer to see general inquiries on the [http://groups.google.com/group/open-platform-community community mailing list] or art related topics go to the [http://groups.google.com/group/sirikata-art-list artist mailing list].  
+
The [http://groups.google.com/group/platformtalk Developer List] is open for all to join and our [http://groups.google.com/group/platformtalk/topics archives] are public. Use for discussion about the platform architecture, protocols, and implementations. Patch sets can also be sent to this list for review and application if you do not have commit access.
 +
 
 +
The [http://groups.google.com/group/sirikata-commits sirikata-commits] list gets automated commit emails from the main Sirikata repository.  
  
 
=== IRC ===  
 
=== IRC ===  
  
Our IRC channel is #sirikata on irc.freenode.net and we keep open([http://sirikata.com/irc/logs/freenode/ logs]). This is used for real time discussion with developers - quick questions, detailed questions about code, etc. If you have never used IRC then the [http://en.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia article on IRC] gives a good overview
+
Our IRC channel is #sirikata on irc.freenode.net and we keep open [http://sirikata.com/irc/logs/freenode/ logs]. This is used for real time discussion with developers - quick questions, detailed questions about code, etc.  
 +
 
 +
If you have never used IRC then the [http://en.wikipedia.org/wiki/Internet_Relay_Chat Wikipedia article on IRC] gives a good overview
  
 
=== Bugs ===  
 
=== Bugs ===  
  
We don't have an issue tracker in place yet, so please send to the [http://groups.google.com/group/platformtalk developer list] for now.
+
We have a [http://github.com/sirikata/sirikata/issues bug database] where we track bugs and feature requests.  This is the best place to report bugs, although you may also want to email the [http://groups.google.com/group/platformtalk developer list] for particularly important bugs or feature requests, and especially for merge requests or patches.
  
=== Events ===
+
Carefully constructed bug reports and responses to requests for additional information or tests are crucial to getting bugs fixed.  At a minimum, bug reports should include
 +
* The version or revision number which the bug was discovered on.  Bonus points if you can track down the revision that introduced the problem.
 +
* The platform you are working on.
 +
* The features you have turned on and/or plugins you have loaded.
 +
* A minimal test case if applicable, or a minimal set of steps needed to reproduce the problem.
 +
* A backtrace if you are reporting a crash and can obtain one.
  
Upcoming meeting in meat space will be announced on the [[Events|events]] page and past meetings will be documented there.
+
We appreciate your attention to detail.

Latest revision as of 23:00, 21 July 2011

Developers stay in touch via a number of mechanisms

Mailing List

The Developer List is open for all to join and our archives are public. Use for discussion about the platform architecture, protocols, and implementations. Patch sets can also be sent to this list for review and application if you do not have commit access.

The sirikata-commits list gets automated commit emails from the main Sirikata repository.

IRC

Our IRC channel is #sirikata on irc.freenode.net and we keep open logs. This is used for real time discussion with developers - quick questions, detailed questions about code, etc.

If you have never used IRC then the Wikipedia article on IRC gives a good overview

Bugs

We have a bug database where we track bugs and feature requests. This is the best place to report bugs, although you may also want to email the developer list for particularly important bugs or feature requests, and especially for merge requests or patches.

Carefully constructed bug reports and responses to requests for additional information or tests are crucial to getting bugs fixed. At a minimum, bug reports should include

  • The version or revision number which the bug was discovered on. Bonus points if you can track down the revision that introduced the problem.
  • The platform you are working on.
  • The features you have turned on and/or plugins you have loaded.
  • A minimal test case if applicable, or a minimal set of steps needed to reproduce the problem.
  • A backtrace if you are reporting a crash and can obtain one.

We appreciate your attention to detail.