Basic sprint information
- IRC channel is #ns-3 at irc.freenode.net
What is a sprint?
A sprint is a scheduled time for ns-3 contributors to gather and focus their undivided attention on improving the code, documentation, or tests.
Sprints are open to anyone, and are conducted on IRC, and if needed, other virtual meeting technologies.
The Djanjo project has a good reference and links to some presentations all about coding sprints.
A summary of the results of sprints will be shared with other developers on the ns-developers mailing list.
- Friday November 15, 14h00-20h00 UTC (note: attendees are welcome to attend a subset of the 6-hour slot, if so desired)
- Topic: Documentation improvement. https://www.nsnam.org/bugzilla/show_bug.cgi?id=938. In particular, we will work on reducing the number of doxygen warnings that are generated due to missing Doxygen. This is a long-standing issue that just requires group effort to resolve.
- Organizer: Tom Henderson (firstname.lastname@example.org)
- Read the general preparation below
- Make sure you have Doxygen installed on your system, and can run the shell script 'doc/doxygen.warnings.report.sh' (it may take a while to run, and should generate a lot of warnings)
- Contact ns-3-users mailing list for help if you have trouble with the above
- Make sure that you can join the IRC channel in advance
- Make sure you can checkout the development version of ns-3 (we will use ns-3-dev)
- Familiarize yourself with how to generate a patch against ns-3-dev. Patches you write can be uploaded to Bugzilla or sent to one of the maintainers.
Once you're there
- Check in by letting others know that you've joined and are ready to contribute, and a maintainer will go from there