Summer of Code/Acceptance

This page is intended to lay out the basic "rules and requirements" that the BRL-CAD project is going to require of all Google Summer of Code participants whose project proposals are accepted. Unless otherwise arranged with the BRL-CAD GSoC project administrator (contact 'brlcad' via IRC on irc.freenode.net), it will be expected that all students comply with the requirements outlined below.

Requirements

Assign copyright and license under the LGPL

Per the GSoC FAQ, BRL-CAD requires that any work performed and provided while participating in BRL-CAD development will be in accordance with BRL-CAD's existing license (LGPL) and that full nonexclusive copyright will be assigned.

Provide weekly progress reports

In addition to any communications you hold with a given mentor, the administrator, or any of the developers, it will be expected of all students that they will submit a brief progress report on a weekly basis. These reports won't need to be more than a few sentences (or at most a couple of paragraphs, whatever is appropriate) but the reports should give an indication of your overall progress, things you discover, tasks completed, difficulties encountered, milestones reached, and other similar details on your activities. You will be expected to complete a report every week, at least once a week. More information on the exact method for providing these reports will be provided after the projects commence.

List your milestones

All projects will be required to submit a minimum of three and a maximum of ten milestones for your project. These are not deliverables but, rather, are overall tasks that should be completed throughout the duration of your work. These should be necessary implementation steps and not include any research or familiarity phases. In the end, there is code that must be produced and your milestones should be a (very) rough breakdown for estimating your actual implementation progress. These milestones should be published in your first progress report, that is, at the beginning of code development.

Join our IRC channel

All students will be expected to join the #brlcad IRC channel on irc.freenode.net. Students are expected to be on the channel while they are working and be responsive to the questions, inquiries, and suggestions of other BRL-CAD developers via IRC and the developer mailing list. While much of BRL-CAD's development occurs over IRC as it is the central gathering forum for core development activities, developer discussions, and more, some mentors will be more readily reached via the mailing list. See here if you are new to IRC and need assistance finding a client (or just do a search). Interaction via IRC is required.

Compile and run BRL-CAD

Being able to compile the sources on your own equipment is a very basic task that is beyond the scope of GSoC and will be an expected unassisted capacity of all students. Additionally, understanding the existing user community is very important for most developers to have at least a basic familiarity with. In the end, your changes will (hopefully) be pushed out to the community and you be cognizant of what that will mean.

Be familiar with the basics of Subversion

BRL-CAD sources live in a Subversion repository on Sourceforge. You will need a Sourceforge account and will be expected to abide by the same coding requirements of the other existing developers. You will similarly be expected to know the basics of how to work with SVN and check in changes, resolve conflicts, and apply patches as needed. SVN has a nearly identical interface to CVS -- if you're familiar with CVS, then you should be fine. If you don't have a Sourceforge account, be sure to get one and familiarize yourself with BRL-CAD's sourceforge account. Whether students work on a branch or on the mainline will vary depending on the student and the project.

Evaluate your performance

As performance is something we always strive to keep in mind, quantitatively evaluate your performance and the impact your modifications will make. Don't prematurely optimize and don't over-architect, but also don't make guesses or assumptions either. Use a performance profiler, test your code, add temporary debug timers, have a peer review your approach, etc. Modifications to the code that detrimentally impact performance will likely be rejected outright.

Write maintainable code

This requirement cannot be stressed enough. One of the primary evaluation criteria for all students is how maintainable is the end result. This is not only maintainability from the stand-point of source code longevity as it stands written, but also involves other higher-level maintainability and integration aspects. Does your implementation use interfaces, languages, tools, or techniques that introduce some new requirement to widespread BRL-CAD development? If so, that choice needs to be discussed and justified or otherwise mitigated as a concern. Any usage of external dependencies needs to be consensus approved by the core developers. Is your code comprehensive and comprehensible? Well-documented? Organized? You are required to follow BRL-CAD's existing developer guidelines, existing code style, and established conventions.

Write portable code

BRL-CAD has an extensive heritage of being as portable as reasonably possible with effort continually being taken to make sure the entire codebase works on a vareity of compilation and run-time environments. While each developer's perception of what is reasonable certainly fluctuates over the years and from developer to developer, the general intention is that code written for BRL-CAD should function the same on most moderately popular operating system environments as much as possible including Linux, Mac OS X, and Windows as well as other platforms. It is each developer's responsibility to either make sure their code isn't platform-specific or that equivalent functionality is provided on other maintained platforms. You are expected to interact with other developers when portability issues are raised to resolve any problems. Portability of any dependencies being used must similarly be taken into account and relates to the aforementioned maintainability requirement.

Write complete code

Perhaps treat each week like it is your last. You should be able to hand over functional code over just about any time during development (within a day or so) to another developer. Focus on completing tasks, completing code features, and working on keeping your code functional at all stages of development. That way, no matter how far you get on your milestones or deliverable(s), other developers will be able to review, test, and readily integrate your code. Plan your development approach accordingly. You should generally not "stub" code functionality (though comments are good), but instead focus on coding "deep" instead of "wide". It's generally preferred to have 2 features that work fully, than 5 features that half-work or even 20 features that are all 90% complete.

Pre-Flight Checklist