Difference between revisions of "Deuces"

(Removed last year's QA tasks)
(restructure)
Line 1: Line 1:
This is a list of succinct tasks that are expected to take most people less than two hours to complete.  It's a great starting point for anyone interested in contributing to BRL-CAD.
+
This is a list of succinct tasks that are expected to take most people familiar with the prerequisites less than two hours to complete.  It's a great starting point for anyone interested in contributing to BRL-CAD.
  
 
The tasks are all roughly the same complexity with '''''no prior BRL-CAD experience expected'''''.  A description is provided along with a list of references and files you'll probably need to edit.  Can we make it any easier?
 
The tasks are all roughly the same complexity with '''''no prior BRL-CAD experience expected'''''.  A description is provided along with a list of references and files you'll probably need to edit.  Can we make it any easier?
Line 5: Line 5:
 
= Getting Started =
 
= Getting Started =
  
Please do contact us (via [[IRC]] or [[Mailing_Lists|brlcad-devel mailing list]]) if you have any questions, corrections, comments, or ideas of your own that you'd like to suggest.
+
Contact us (via [[IRC]] or [[Mailing_Lists|brlcad-devel mailing list]]) if you have questions, comments, or ideas of your own you'd like to suggest.
  
We've made a really awesome virtual disk image that has everything you need included, preconfigured, and ready to be edited.  Here's what you do:
+
We've made an awesome virtual disk image that has everything you need preconfigured and ready to go:
# [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20for%20Virtual%20Machines/ Download our BRL-CAD Virtual Machine (VM) image.]
+
# [https://www.virtualbox.org/wiki/Downloads Download, install, and run VirtualBox.]
+
# Import the BRL-CAD VM, start it, and log in (the password is "Brlcad!" without the quotes).
+
# Run "svn up brlcad.svn" and get started compiling!
+
  
= When You're Done =
+
# [https://sourceforge.net/projects/brlcad/files/BRL-CAD%20for%20Virtual%20Machines/ Download our BRL-CAD Virtual Machine (VM) disk image.]
 +
# [https://www.virtualbox.org/wiki/Downloads Install VirtualBox.]
 +
# Import and start the VM, log in (the password is "Brlcad!" without the quotes).
 +
# Run "svn up brlcad.svn" and get started!
  
For non-code, just send us your file(s).  For code changes, you will be expected to [[Patches|provide a patch file]].  Make sure you ''read'' your patch file before submitting it.  Make sure your patch file will apply cleanly to an unmodified checkout of BRL-CAD:
+
=Pick a Task=
  
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.edit
+
We break down all tasks into one of five categoriesDon't be worried if the tasks all sound confusing to youJust pick one and start reading the references we've providedJoin IRC or our mailing list and ask questions.
  cd brlcad.edit
+
 
  # make changes
+
# Code (programming)
svn diff > ~/my.patch
+
# Documentation and Training (writing)
  # read ~/my.patch file with text editor
+
# Outreach and Research (graphics)
cd ..
+
# Quality Assurance (testing)
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.fresh
+
# User Interface (designing)
cd brlcad.fresh
+
patch -p0 < ~/my.patch
+
# submit your patch file to our patches tracker
+
&nbsp;
+
  
 
__TOC__
 
__TOC__
Line 33: Line 28:
 
----
 
----
  
= Code =
+
== Code ==
 
----
 
----
 
''Tasks related to writing or refactoring code''
 
''Tasks related to writing or refactoring code''
Line 42: Line 37:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Fix bounding box function for our polygonal mesh (BoT) primitive ==
+
=== Fix bounding box function for our polygonal mesh (BoT) primitive ===
  
 
BRL-CAD provides functions for its geometric primitives that define a bounding box - a box that completely encloses the volume described by the primitive.  Ideally, these boxes are as small as possible while still enclosing the primitive.  Currently the routine for BoTs is incorrect.  You can use stl-g, obj-g, or any of our other *-g converters to import BoT geometry for testing.  
 
BRL-CAD provides functions for its geometric primitives that define a bounding box - a box that completely encloses the volume described by the primitive.  Ideally, these boxes are as small as possible while still enclosing the primitive.  Currently the routine for BoTs is incorrect.  You can use stl-g, obj-g, or any of our other *-g converters to import BoT geometry for testing.  
Line 56: Line 51:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Close MGED when both windows are closed ==
+
=== Close MGED when both windows are closed ===
  
 
BRL-CAD has an interactive geometry editor called MGED.  It's often the starting point for beginners and allows creation and manipulation of models using commands.  When ''mged'' is run, it creates 2 windows:  a text-console command window and an interactive graphics window.  When the user closes one of those windows, there is a bug.  Closing the graphics window closes the command window.
 
BRL-CAD has an interactive geometry editor called MGED.  It's often the starting point for beginners and allows creation and manipulation of models using commands.  When ''mged'' is run, it creates 2 windows:  a text-console command window and an interactive graphics window.  When the user closes one of those windows, there is a bug.  Closing the graphics window closes the command window.
Line 70: Line 65:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Add MGED key-binding to reopen the command window ==
+
=== Add MGED key-binding to reopen the command window ===
  
 
BRL-CAD has an interactive geometry editor called MGED. It's often the starting point for beginners and allows creation and manipulation of models using commands. When MGED is invoked, it creates 2 windows:  a text-console command window and an interactive graphics window.  If the user closes the text-console command window, they are left with the interactive graphics window.  There is presently no way (correct us if we're wrong) to get the text-console back without restarting mged.  A good way to test this is to run in classic mode and run the 'gui' command:
 
BRL-CAD has an interactive geometry editor called MGED. It's often the starting point for beginners and allows creation and manipulation of models using commands. When MGED is invoked, it creates 2 windows:  a text-console command window and an interactive graphics window.  If the user closes the text-console command window, they are left with the interactive graphics window.  There is presently no way (correct us if we're wrong) to get the text-console back without restarting mged.  A good way to test this is to run in classic mode and run the 'gui' command:
Line 94: Line 89:
 
|
 
|
  
== Implement a primitive surface area function ==
+
=== Implement a primitive surface area function ===
  
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
Line 107: Line 102:
  
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... surface area function for elliptical hyperboloids (EHY) ===
+
==== ... surface area function for elliptical hyperboloids (EHY) ====
  
 
Code:
 
Code:
Line 117: Line 112:
  
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... surface area function for hyperboloids of one sheet (HYP) ===
+
==== ... surface area function for hyperboloids of one sheet (HYP) ====
  
 
Code:
 
Code:
Line 127: Line 122:
  
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... surface area function for N-faced polysolid (ARBN) ===
+
==== ... surface area function for N-faced polysolid (ARBN) ====
  
 
Code:
 
Code:
Line 136: Line 131:
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... surface area function for extruded bitmaps (EBM) ===
+
==== ... surface area function for extruded bitmaps (EBM) ====
  
 
Code:
 
Code:
Line 145: Line 140:
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... surface area function for gridded volumes (VOL) ===
+
==== ... surface area function for gridded volumes (VOL) ====
  
 
Code:
 
Code:
Line 154: Line 149:
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... surface area function for super ellipsoids (SUPERELL) ===
+
==== ... surface area function for super ellipsoids (SUPERELL) ====
  
 
Code:
 
Code:
Line 163: Line 158:
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... surface area function for polygonal meshes (NMG) ===
+
==== ... surface area function for polygonal meshes (NMG) ====
  
 
Code:
 
Code:
Line 173: Line 168:
  
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... surface area function for NURBS objects (BREP) ===
+
==== ... surface area function for NURBS objects (BREP) ====
  
 
Code:
 
Code:
Line 187: Line 182:
 
|
 
|
  
== Implement a primitive volume function ==
+
=== Implement a primitive volume function ===
  
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more difficult to compute.
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more difficult to compute.
Line 199: Line 194:
 
* include/raytrace.h: See ft_volume callback defined in rt_functab structure
 
* include/raytrace.h: See ft_volume callback defined in rt_functab structure
  
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... volume function for elliptical hyperboloids (EHY) ===
+
==== ... volume function for elliptical hyperboloids (EHY) ====
  
 
Code:
 
Code:
Line 209: Line 204:
  
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... volume function for superellipsoids (SUPERELL) ===
+
==== ... volume function for superellipsoids (SUPERELL) ====
  
 
Code:
 
Code:
Line 218: Line 213:
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... volume function for extruded bitmaps (EBM) ===
+
==== ... volume function for extruded bitmaps (EBM) ====
  
 
Code:
 
Code:
Line 228: Line 223:
  
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... volume function for triangle meshes (BOT) ===
+
==== ... volume function for triangle meshes (BOT) ====
  
 
Code:
 
Code:
Line 237: Line 232:
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... volume function for solid polygonal meshes (NMG) ===
+
==== ... volume function for solid polygonal meshes (NMG) ====
  
 
Code:
 
Code:
Line 246: Line 241:
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... volume function for extruded sketches (EXTRUDE) ===
+
==== ... volume function for extruded sketches (EXTRUDE) ====
  
 
Code:
 
Code:
Line 260: Line 255:
 
|
 
|
  
== Implement a primitive centroid function ==
+
=== Implement a primitive centroid function ===
  
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.
Line 276: Line 271:
  
  
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... centroid function for right hyperbolic cylinders (RHC) ===
+
==== ... centroid function for right hyperbolic cylinders (RHC) ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... centroid function for gridded volumes (VOL) ===
+
==== ... centroid function for gridded volumes (VOL) ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... centroid function for N-faced polysolids (ARBN) ===
+
==== ... centroid function for N-faced polysolids (ARBN) ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... centroid function for extruded sketches (EXTRUDE) ===
+
==== ... centroid function for extruded sketches (EXTRUDE) ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... centroid function for superellipsoids (SUPERELL) ===
+
==== ... centroid function for superellipsoids (SUPERELL) ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... centroid function for solid polygonal meshes (NMG) ===
+
==== ... centroid function for solid polygonal meshes (NMG) ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
Line 312: Line 307:
 
|
 
|
  
== Implement a primitive UV-mapping callback ==
+
=== Implement a primitive UV-mapping callback ===
  
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  One of those functions describes a UV mapping of the object's surface, which is used for things like texture and bump mapping.  An example of this is rt_ell_uv() in the src/librt/primitives/ell/ell.c source file for an ellipsoid.  Several of our more complex primitive types (such as BoT, NMG, and BREP/NURBS) do not presently implement a UV-mapping function leading to unexpected runtime behavior.
 
BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones.  Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid.  One of those functions describes a UV mapping of the object's surface, which is used for things like texture and bump mapping.  An example of this is rt_ell_uv() in the src/librt/primitives/ell/ell.c source file for an ellipsoid.  Several of our more complex primitive types (such as BoT, NMG, and BREP/NURBS) do not presently implement a UV-mapping function leading to unexpected runtime behavior.
Line 322: Line 317:
 
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c, read the rt_*_uv() function
 
* src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c, read the rt_*_uv() function
  
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... UV-mapping for extruded sketches (EXTRUDE) ===
+
==== ... UV-mapping for extruded sketches (EXTRUDE) ====
  
 
Code:
 
Code:
Line 339: Line 334:
 
----
 
----
  
= Documentation and Training =
+
== Documentation and Training ==
 
----
 
----
 
''Tasks related to creating/editing documents and helping others learn more about BRL-CAD''
 
''Tasks related to creating/editing documents and helping others learn more about BRL-CAD''
Line 345: Line 340:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Add missing documentation (for any ONE command) ==
+
=== Add missing documentation (for any ONE command) ===
  
 
BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
 
BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:
Line 362: Line 357:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Document MGED's 'saveview' command options ==
+
=== Document MGED's 'saveview' command options ===
  
 
BRL-CAD's primary geometry editor (MGED) provides hundreds of commands.  Two of those commands are the savewview and loadview commands that write current view settings out to a text file and read them back in.  The saveview command provides -e -i -l and -o options, but they are not documented.
 
BRL-CAD's primary geometry editor (MGED) provides hundreds of commands.  Two of those commands are the savewview and loadview commands that write current view settings out to a text file and read them back in.  The saveview command provides -e -i -l and -o options, but they are not documented.
Line 380: Line 375:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Write a "BRL-CAD Commands Quick Reference" document ==
+
=== Write a "BRL-CAD Commands Quick Reference" document ===
  
 
There is already a command quick reference for BRL-CAD's MGED geometry editing tool, but there is not a similar document for BRL-CAD's 400+ command-line commands.
 
There is already a command quick reference for BRL-CAD's MGED geometry editing tool, but there is not a similar document for BRL-CAD's 400+ command-line commands.
Line 401: Line 396:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Doxygen cleanup ==
+
=== Doxygen cleanup ===
  
 
BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.
 
BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.
Line 412: Line 407:
 
* http://www.stack.nl/~dimitri/doxygen/
 
* http://www.stack.nl/~dimitri/doxygen/
  
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... doxygen cleanup for LIBBU ===
+
==== ... doxygen cleanup for LIBBU ====
  
 
There are approximately 300 documented API function calls in LIBBU.
 
There are approximately 300 documented API function calls in LIBBU.
Line 426: Line 421:
  
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... doxygen cleanup for LIBWDB ===
+
==== ... doxygen cleanup for LIBWDB ====
  
 
There are approximately 100 documented API function calls in LIBWDB.  
 
There are approximately 100 documented API function calls in LIBWDB.  
Line 440: Line 435:
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... doxygen cleanup for LIBRT ===
+
==== ... doxygen cleanup for LIBRT ====
  
 
There are approximately 1000 documented API function calls in LIBRT.  
 
There are approximately 1000 documented API function calls in LIBRT.  
Line 458: Line 453:
 
----
 
----
  
= Outreach and Research =
+
==Outreach and Research ==
 
----
 
----
 
''Tasks related to community management, outreach/marketing, studying problems, and recommending solutions''
 
''Tasks related to community management, outreach/marketing, studying problems, and recommending solutions''
Line 466: Line 461:
 
|
 
|
  
== Investigate permuted vertex lists from g-iges + iges-g ==
+
=== Investigate permuted vertex lists from g-iges + iges-g ===
  
 
BRL-CAD has a geometry exporter and importer for the International Graphics Exchange Standard (IGES) file format.  If you run our g-iges exporter on some geometry, then run iges-g on that same geometry to import it back to BRL-CAD format, the geometry will have permuted vertex lists.  Particularly for geometry already in polygonal format, such as our NMG or BoT geometry, this conversion should result in identical geometry but presently does not.
 
BRL-CAD has a geometry exporter and importer for the International Graphics Exchange Standard (IGES) file format.  If you run our g-iges exporter on some geometry, then run iges-g on that same geometry to import it back to BRL-CAD format, the geometry will have permuted vertex lists.  Particularly for geometry already in polygonal format, such as our NMG or BoT geometry, this conversion should result in identical geometry but presently does not.
Line 479: Line 474:
 
----
 
----
  
= Quality Assurance =
+
== Quality Assurance ==
 
----
 
----
 
''Tasks related to testing and ensuring code is of high quality''
 
''Tasks related to testing and ensuring code is of high quality''
Line 485: Line 480:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Fix single-precision floating point crash ==
+
=== Fix single-precision floating point crash ===
  
 
By default, all of BRL-CAD compiles using double-precision floating point arithmetic.  We provide a simple typedef, however, that converts almost the entire system over to single-precision floating point.  This compilation mode was recently cleaned up and tested, but a bug was found.  The problem is reproduced very simply by compiling in single precision mode and running our "rt" ray tracer tool.
 
By default, all of BRL-CAD compiles using double-precision floating point arithmetic.  We provide a simple typedef, however, that converts almost the entire system over to single-precision floating point.  This compilation mode was recently cleaned up and tested, but a bug was found.  The problem is reproduced very simply by compiling in single precision mode and running our "rt" ray tracer tool.
Line 522: Line 517:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Fix closedb ==
+
=== Fix closedb ===
  
 
BRL-CAD geometry editor application (mged) has several hundred commands including two very simple commands for opening and closing a geometry database file.  While the user rarely ever needs to close the file, as all changes are always immediately saved, it can be of use to scripting applications.  However, at some point in the recent past, the ''closedb'' command was horked.  It's undoubtedly something very simple but we haven't bothered to look due to other priorities.  You can fix it.  If you run these simple steps within graphical mged, you should see how commands stop working after calling closedb:
 
BRL-CAD geometry editor application (mged) has several hundred commands including two very simple commands for opening and closing a geometry database file.  While the user rarely ever needs to close the file, as all changes are always immediately saved, it can be of use to scripting applications.  However, at some point in the recent past, the ''closedb'' command was horked.  It's undoubtedly something very simple but we haven't bothered to look due to other priorities.  You can fix it.  If you run these simple steps within graphical mged, you should see how commands stop working after calling closedb:
Line 545: Line 540:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Create an utility library (LIBBU) API unit test ==
+
=== Create an utility library (LIBBU) API unit test ===
  
 
There are more than 300 library functions in our core LIBBU library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
 
There are more than 300 library functions in our core LIBBU library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
Line 560: Line 555:
 
* src/libbu/tests/CMakeLists.txt
 
* src/libbu/tests/CMakeLists.txt
  
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... unit test for LIBBU badmagic.c ===
+
==== ... unit test for LIBBU badmagic.c ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... unit test for LIBBU bomb.c ===
+
==== ... unit test for LIBBU bomb.c ====
 
|}
 
|}
 
|}
 
|}
Line 574: Line 569:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Create numerics library (LIBBN) API unit test ==
+
=== Create numerics library (LIBBN) API unit test ===
  
 
There are more than 300 library functions in our core LIBBN library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
 
There are more than 300 library functions in our core LIBBN library.  As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.
Line 591: Line 586:
 
* src/libbn/tests/CMakeLists.txt
 
* src/libbn/tests/CMakeLists.txt
  
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... unit test for LIBBN axis.c ===
+
==== ... unit test for LIBBN axis.c ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... unit test for LIBBN qmath.c ===
+
==== ... unit test for LIBBN qmath.c ====
 
|}
 
|}
 
&nbsp;
 
&nbsp;
{| style="background-color:#222222;" cellpadding="20" cellspacing="0" border="2" width="100%"
+
{| cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
=== ... unit test for LIBBN rand.c ===
+
==== ... unit test for LIBBN rand.c ====
 
|}
 
|}
 
|}
 
|}
Line 610: Line 605:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Find, reliably reproduce, and report any bug in Archer ==
+
=== Find, reliably reproduce, and report any bug in Archer ===
  
 
Archer is our new modeling interface and a soon to merge with our long-standing MGED geometry editor.  It undoubtedly has bugs.  It's your job to find one, but do so in a manner that is so obvious that one of the other devs will be able to instantly reproduce the bug given your specific instructions.  Find a way to make archer crash, become unresponsive, or otherwise behave incorrectly.  You will have to explore the tool with minimal documentation.
 
Archer is our new modeling interface and a soon to merge with our long-standing MGED geometry editor.  It undoubtedly has bugs.  It's your job to find one, but do so in a manner that is so obvious that one of the other devs will be able to instantly reproduce the bug given your specific instructions.  Find a way to make archer crash, become unresponsive, or otherwise behave incorrectly.  You will have to explore the tool with minimal documentation.
Line 626: Line 621:
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
{| style="background-color:#666666;" cellpadding="20" cellspacing="0" border="2" width="100%"
 
|
 
|
== Reproduce any 10 unconfirmed open bug reports ==
+
=== Reproduce any 10 unconfirmed open bug reports ===
  
 
BRL-CAD presently has approximately 75 open bug reports of which 50 are unassigned.  Read the comments and status to see if the bug has been confirmed/reproduced.   
 
BRL-CAD presently has approximately 75 open bug reports of which 50 are unassigned.  Read the comments and status to see if the bug has been confirmed/reproduced.   
Line 637: Line 632:
 
----
 
----
  
= User Interface =
+
== User Interface ==
 
----
 
----
 
''Tasks related to user experience research or user interface design and interaction''
 
''Tasks related to user experience research or user interface design and interaction''
 +
 +
 +
= When You're Done =
 +
----
 +
 +
For non-code, just send us your file(s).  For code changes, you will be expected to [[Patches|provide a patch file]].  Make sure you ''read'' your patch file before submitting it.  Make sure your patch file will apply cleanly to an unmodified checkout of BRL-CAD:
 +
 +
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.edit
 +
cd brlcad.edit
 +
# make changes
 +
svn diff > ~/my.patch
 +
# read ~/my.patch file with text editor
 +
cd ..
 +
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.fresh
 +
cd brlcad.fresh
 +
patch -p0 < ~/my.patch
 +
# submit your patch file to our patches tracker
 +
&nbsp;

Revision as of 22:23, 28 October 2013

This is a list of succinct tasks that are expected to take most people familiar with the prerequisites less than two hours to complete. It's a great starting point for anyone interested in contributing to BRL-CAD.

The tasks are all roughly the same complexity with no prior BRL-CAD experience expected. A description is provided along with a list of references and files you'll probably need to edit. Can we make it any easier?

Getting Started

Contact us (via IRC or brlcad-devel mailing list) if you have questions, comments, or ideas of your own you'd like to suggest.

We've made an awesome virtual disk image that has everything you need preconfigured and ready to go:

  1. Download our BRL-CAD Virtual Machine (VM) disk image.
  2. Install VirtualBox.
  3. Import and start the VM, log in (the password is "Brlcad!" without the quotes).
  4. Run "svn up brlcad.svn" and get started!

Pick a Task

We break down all tasks into one of five categories. Don't be worried if the tasks all sound confusing to you. Just pick one and start reading the references we've provided. Join IRC or our mailing list and ask questions.

  1. Code (programming)
  2. Documentation and Training (writing)
  3. Outreach and Research (graphics)
  4. Quality Assurance (testing)
  5. User Interface (designing)

Contents


Code


Tasks related to writing or refactoring code

See the When You're Done section above for details on submitting your changes.

 

Fix bounding box function for our polygonal mesh (BoT) primitive

BRL-CAD provides functions for its geometric primitives that define a bounding box - a box that completely encloses the volume described by the primitive. Ideally, these boxes are as small as possible while still enclosing the primitive. Currently the routine for BoTs is incorrect. You can use stl-g, obj-g, or any of our other *-g converters to import BoT geometry for testing.

This task involves studying the current code for the function rt_bot_bbox() and determining what is causing the current inaccuracies (the mged 'bb' command is a good way to visualize primitive bounding boxes). Make changes to produce a more optimal bounding box. Reimplement it from scratch if you like. The raytracing prep code in rt_bot_prep does prepare a better bounding box, so that is one place to check.

Code:

  • src/librt/primitives/bot/bot.c

   

Close MGED when both windows are closed

BRL-CAD has an interactive geometry editor called MGED. It's often the starting point for beginners and allows creation and manipulation of models using commands. When mged is run, it creates 2 windows: a text-console command window and an interactive graphics window. When the user closes one of those windows, there is a bug. Closing the graphics window closes the command window.

This task involves fixing this behavior so that ONLY closing both windows terminates the process properly and that closing either window does not take the other along with it.

Code:

  • src/mged/mged.c
  • src/tclscripts/mged/openw.c

 

Add MGED key-binding to reopen the command window

BRL-CAD has an interactive geometry editor called MGED. It's often the starting point for beginners and allows creation and manipulation of models using commands. When MGED is invoked, it creates 2 windows: a text-console command window and an interactive graphics window. If the user closes the text-console command window, they are left with the interactive graphics window. There is presently no way (correct us if we're wrong) to get the text-console back without restarting mged. A good way to test this is to run in classic mode and run the 'gui' command:

sushi:~ morrison$ mged -c test.g
BRL-CAD Release 7.22.0  Geometry Editor (MGED)
    Fri, 24 Aug 2012 00:02:42 -0400, Compilation 6
    morrison@sushi.local:/usr/brlcad/rel-7.22.0

attach (nu|X|ogl)[nu]?   
mged> gui

This task involves adding some mechanism, perhaps a simple key binding, to the graphics window so that you can get the command window back on-demand.

Code:

  • src/mged/mged.c
  • src/tclscripts/mged/openw.c

 

Implement a primitive surface area function

BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.

This task involves writing a new callback function that takes an rt_db_internal object and calculates the surface area (units are mm^2). There are numerous examples in our code where we compute surface area for other primitives. The primitives that do not already have a centroid callback are itemized in following.

References:

 

... surface area function for elliptical hyperboloids (EHY)

Code:

  • src/librt/primitives/ehy/ehy.c

 

... surface area function for hyperboloids of one sheet (HYP)

Code:

  • src/librt/primitives/hyp/hyp.c

 

... surface area function for N-faced polysolid (ARBN)

Code:

  • src/librt/primitives/arbn/arbn.c

 

... surface area function for extruded bitmaps (EBM)

Code:

  • src/librt/primitives/ebm/ebm.c

 

... surface area function for gridded volumes (VOL)

Code:

  • src/librt/primitives/vol/vol.c

 

... surface area function for super ellipsoids (SUPERELL)

Code:

  • src/librt/primitives/superell/superell.c

 

... surface area function for polygonal meshes (NMG)

Code:

  • src/librt/primitives/nmg/nmg.c

 

... surface area function for NURBS objects (BREP)

Code:

  • src/librt/primitives/brep/brep.cpp

 

Implement a primitive volume function

BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more difficult to compute.

This task involves writing a new callback function that takes an rt_db_internal object and calculates the volume (units are mm^3). There are numerous examples in our code where we compute volume for other primitives. The primitives that do not already have a volume callback are itemized in following.

References:

... volume function for elliptical hyperboloids (EHY)

Code:

  • src/librt/primitives/ehy/ehy.c

 

... volume function for superellipsoids (SUPERELL)

Code:

  • src/librt/primitives/superell/superell.c

 

... volume function for extruded bitmaps (EBM)

Code:

  • src/librt/primitives/ebm/ebm.c

 

... volume function for triangle meshes (BOT)

Code:

  • src/librt/primitives/bot/bot.c

 

... volume function for solid polygonal meshes (NMG)

Code:

  • src/librt/primitives/nmg/nmg.c

 

... volume function for extruded sketches (EXTRUDE)

Code:

  • src/librt/primitives/extrude/extrude.c

 

Implement a primitive centroid function

BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. Wikipedia, Wolfram Mathworld, and various other math sites (and research papers) around the web include the equations for most of our basic primitives while others are a little more tricky to compute.

This task involves writing a new callback function that takes an rt_db_internal object and calculates its centroid (as a point_t 3D point). There are numerous examples in our code where we compute centroids for other primtiives. The primitives that do not already have a centroid callback are itemized in following.

References:

Code:

  • src/librt/primitives/table.c
  • src/librt/primitives/[PRIMITIVE]/[PRIMITIVE].c


... centroid function for right hyperbolic cylinders (RHC)

 

... centroid function for gridded volumes (VOL)

 

... centroid function for N-faced polysolids (ARBN)

 

... centroid function for extruded sketches (EXTRUDE)

 

... centroid function for superellipsoids (SUPERELL)

 

... centroid function for solid polygonal meshes (NMG)

 

 

Implement a primitive UV-mapping callback

BRL-CAD provides more than two dozen types of geometry "primitives" such as ellipsoids, boxes, and cones. Every primitive is described by a collection of callback functions, for example rt_ell_bbox() returns the bounding box dimensions for an ellipsoid. One of those functions describes a UV mapping of the object's surface, which is used for things like texture and bump mapping. An example of this is rt_ell_uv() in the src/librt/primitives/ell/ell.c source file for an ellipsoid. Several of our more complex primitive types (such as BoT, NMG, and BREP/NURBS) do not presently implement a UV-mapping function leading to unexpected runtime behavior.

This task involves implementing a UV-mapping callback for any of the primitives that do not already have a functional UV-callback defined. Note that this is an advanced task that might take you more than a couple hours if you don't have solid coding skills, but it's ultimately just a few lines of code. See other primitives that already implement a UV-mapping callback for reference.

References:

... UV-mapping for extruded sketches (EXTRUDE)

Code:

  • src/librt/primitives/extrude/extrude.c
  • src/librt/primitives/table.c
  • include/rtgeom.h

 

 


Documentation and Training


Tasks related to creating/editing documents and helping others learn more about BRL-CAD

Add missing documentation (for any ONE command)

BRL-CAD is an extensive system with more than 400 commands and more than a million pages of documentation, but there are approximately 120 commands that are entirely undocumented:

a-d archer asc2g asc2pix bot-bldxf bottest brep_cube brep_simple brickwall btclsh burst bw-a bw-d bwish c-d chan_add clutter contours d-a damdf dauto dauto2 d-bw dconv ddisp d-f dfft d-i dmod double-asc dpeak dsel dsp_add dstat d-u dwin euclid_format euclid_unformat fbgammamod f-d fence fhor f-i g-adrt g-euclid1 g-jack globe g-off i-a i-d i-f ihist imod istat jack-g kurt lowp molecule nmgmodel nmg-sgp off-g pipe pipetest pix2g pix3filter pixcount pixelswap pixembed pixfields pixfieldsep pixflip-fb pixpaste pix-spm pix-yuv plstat pyramid rawbot remapid rlesortmap rletovcr room rtcell rtexample rtfrac rtrad rtsil rtsrv script-tab sketch solshoot sphflake spltest spm-fb ssampview syn tea tea_nmg testfree texturescale torii ttcp tube txyz-pl u-a u-bw u-d u-f umod ustat vcrtorle vegitation wall wdb_example xbmtorle xyz-pl yuv-pix

This task involves writing basic documentation for JUST ONE of those commands in the Docbook XML format. The command documentation should provide a one-sentence description, a detailed paragraph description (200+ words), explanation of all available command-line options, and one or more examples on how to use the command.

Code:

  • doc/docbook/system/man1/en/Makefile.am
  • doc/docbook/system/man1/en/*.xml

 

Document MGED's 'saveview' command options

BRL-CAD's primary geometry editor (MGED) provides hundreds of commands. Two of those commands are the savewview and loadview commands that write current view settings out to a text file and read them back in. The saveview command provides -e -i -l and -o options, but they are not documented.

This task involves writing documentation for those missing options. Consult the source code to see what they do and add the corresponding sections into our Docbook XML doc just like we do in our other documentation files. Test compilation to make sure your XML syntax is correct.

References:

  • src/libged/saveview.c
  • doc/docbook/system/mann/en/*.xml

Code:

  • doc/docbook/system/mann/en/saveview.xml

 

Write a "BRL-CAD Commands Quick Reference" document

There is already a command quick reference for BRL-CAD's MGED geometry editing tool, but there is not a similar document for BRL-CAD's 400+ command-line commands.

This task involves writing a quick reference document similar to the MGED quick reference but for BRL-CAD commands. The sheet should minimally include the following commands:

mged, rt*, *-g, g-*, fb*, *fb, nirt, remrt, rtsrv, asc2g, g2asc, dbupgrade, pix*, *pix, *-*, brlman, benchmark

References:

 

Doxygen cleanup

BRL-CAD uses Doxygen for most API documentation but the comment blocks are not optimally set up for Doxygen output.

This task involves cleaning up the Doxygen comments in the library so that useful reports and API documentation automatically generated (correctly, completely, and cleanly). Verify/fix any Doxygen syntax. Verify/fix groups so that functions are organized neatly and all contained within a group. Provide patches that give clean (PDF) output from Doxygen.

References:

... doxygen cleanup for LIBBU

There are approximately 300 documented API function calls in LIBBU.

Code:

  • include/bu.h
  • src/libbu
  • misc/Doxyfile

 

... doxygen cleanup for LIBWDB

There are approximately 100 documented API function calls in LIBWDB.

Code:

  • include/wdb.h
  • include/raytrace.h
  • src/libwdb
  • misc/Doxyfile

 

... doxygen cleanup for LIBRT

There are approximately 1000 documented API function calls in LIBRT.

Code:

  • include/raytrace.h
  • src/librt
  • src/librt/primitives
  • src/librt/comb
  • src/librt/binunif
  • misc/Doxyfile

Outreach and Research


Tasks related to community management, outreach/marketing, studying problems, and recommending solutions

 

Investigate permuted vertex lists from g-iges + iges-g

BRL-CAD has a geometry exporter and importer for the International Graphics Exchange Standard (IGES) file format. If you run our g-iges exporter on some geometry, then run iges-g on that same geometry to import it back to BRL-CAD format, the geometry will have permuted vertex lists. Particularly for geometry already in polygonal format, such as our NMG or BoT geometry, this conversion should result in identical geometry but presently does not.

This task involves investigating why this occurs, reporting (in detail) why it occurs, and if obvious, making a recommendation on how to fix the problem.

Code:

  • src/conv/iges

Quality Assurance


Tasks related to testing and ensuring code is of high quality

Fix single-precision floating point crash

By default, all of BRL-CAD compiles using double-precision floating point arithmetic. We provide a simple typedef, however, that converts almost the entire system over to single-precision floating point. This compilation mode was recently cleaned up and tested, but a bug was found. The problem is reproduced very simply by compiling in single precision mode and running our "rt" ray tracer tool.

To compile in single precision, edit the include/bn.h header file and change the fastf_t typedef from double to float. To reproduce the bug, compile BRL-CAD and write this out to a text file named star.view:

viewsize 2.500000000e+05;
eye_pt 2.102677960e+05 8.455500000e+04 2.934714650e+04;
viewrot -6.733560560e-01 6.130643360e-01 4.132114880e-01 0.000000000e+00
        5.539599410e-01 4.823888300e-02 8.311441420e-01 0.000000000e+00
        4.896120540e-01 7.885590550e-01 -3.720948210e-01 0.000000000e+00
        0.000000000e+00 0.000000000e+00 0.000000000e+00 1.000000000e+00 ;
start 0;
end;

Then run rt feeding it that view script as input. This is an example how to run within the gdb debugger:

gdb path/to/bin/rt
...
(gdb) run -F/dev/X -M .cmake/share/db/star.g all < star.view

At this point, rt should crash due to an infinite recursion. A backtrace in the debugger will show lots and lots of calls to rt_shootray() and light_hit().

This task involves investigating and preventing the crash. Provide a patch that fixes the bug.

References:

  • man gdb
  • brlman rt

Code:

  • src/librt/shoot.c
  • src/liboptical/sh_light.c

 

Fix closedb

BRL-CAD geometry editor application (mged) has several hundred commands including two very simple commands for opening and closing a geometry database file. While the user rarely ever needs to close the file, as all changes are always immediately saved, it can be of use to scripting applications. However, at some point in the recent past, the closedb command was horked. It's undoubtedly something very simple but we haven't bothered to look due to other priorities. You can fix it. If you run these simple steps within graphical mged, you should see how commands stop working after calling closedb:

 mged> opendb test.g y
 mged> make sph sph
 mged> l sph
 mged> closedb
 mged> make sph sph
 mged> opendb test.g
 mged> l sph
 mged> exit

Provide a patch that fixes the bug or tell us which SVN revision introduced the bug. Make sure you can reproduce the bug before claiming this task, which presumes you know how to download/install BRL-CAD from a source distribution.

Code:

  • src/mged/mged.c

 

Create an utility library (LIBBU) API unit test

There are more than 300 library functions in our core LIBBU library. As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.

This task involves implementing a new unit test for any of LIBBU's source files that do not already have a unit test defined. The test should run all of the public functions and be hooked into our build system. We have lots of existing unit tests to follow as an example.

References:

  • include/bu.h
  • src/libbu/*.c
  • src/libbu/tests/*.c

Code:

  • src/libbu/tests/[TEST].c
  • src/libbu/tests/CMakeLists.txt

... unit test for LIBBU badmagic.c

 

... unit test for LIBBU bomb.c

 

Create numerics library (LIBBN) API unit test

There are more than 300 library functions in our core LIBBN library. As a core library used by nearly every one of BRL-CAD's tools, testing those functions for correct behavior is important.

This task involves implementing a new unit test for any of LIBBN's source files that do not already have a unit test defined. The test should run all of the public functions and be hooked into our build system. We have lots of existing unit tests to follow as an example.

References:

  • include/bn.h
  • include/plot3.h
  • include/vmath.h
  • src/libbn/*.c
  • src/libbu/tests/*.c <-- note libbu, not libbn for examples

Code:

  • src/libbn/tests/[TEST].c
  • src/libbn/tests/CMakeLists.txt

... unit test for LIBBN axis.c

 

... unit test for LIBBN qmath.c

 

... unit test for LIBBN rand.c

 

Find, reliably reproduce, and report any bug in Archer

Archer is our new modeling interface and a soon to merge with our long-standing MGED geometry editor. It undoubtedly has bugs. It's your job to find one, but do so in a manner that is so obvious that one of the other devs will be able to instantly reproduce the bug given your specific instructions. Find a way to make archer crash, become unresponsive, or otherwise behave incorrectly. You will have to explore the tool with minimal documentation.

This task involves filing a bug report with verifiable and reproducible steps that clearly demonstrate the bug. It can't be a bug already reported or otherwise documented nor can it be merely behavior you don't like.

References:

 

Reproduce any 10 unconfirmed open bug reports

BRL-CAD presently has approximately 75 open bug reports of which 50 are unassigned. Read the comments and status to see if the bug has been confirmed/reproduced.

This task involves going through those reports and REPRODUCE at least 10 of the ones that have not been confirmed. When you can reproduce the issue being reported, you'll comment on the thread to state as much and attach any data you used to reproduce the crash.

References:


User Interface


Tasks related to user experience research or user interface design and interaction


When You're Done


For non-code, just send us your file(s). For code changes, you will be expected to provide a patch file. Make sure you read your patch file before submitting it. Make sure your patch file will apply cleanly to an unmodified checkout of BRL-CAD:

svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.edit
cd brlcad.edit
# make changes
svn diff > ~/my.patch
# read ~/my.patch file with text editor
cd ..
svn co https://brlcad.svn.sourceforge.net/svnroot/brlcad/brlcad/trunk brlcad.fresh
cd brlcad.fresh
patch -p0 < ~/my.patch
# submit your patch file to our patches tracker