Documentation

JQuerySprint

From jQuery JavaScript Library

Jump to: navigation, search

The jQuery UI team held a worldwide Sprint, Friday and Saturday, March 14 and 15, 2008. Thanks to all who joined us as we ran really fast to ready the final release of jQuery UI 1.5.

[edit]

Date & Location

March 14-15, 2008: The event took place all day Fri. and Sat. As this was a worldwide event, there was no physical location for attendance. Just an irc channel and a wiki page.

The working code can be downloaded at:

svn co http://jqueryjs.googlecode.com/svn/trunk/ui

[edit]

What's the Big Idea?

We want to have all the focus and productivity possible directed towards the next jQuery UI release, for two fun-filled days. With your help, we'll finish all issues, testing and documentation for UI 1.5. That means that our final goal is a stable and well-documented jQuery UI 1.5, ready for final release.

We're anxious to have help from new and old team members, and anyone else that has an interest in making jQuery UI great.

[edit]

How To Contribute

If you don't already have one, you'll need a wiki account on docs.jquery.com and a trac account on dev.jquery.com. If you don't have commit/svn access, use trac tickets to attach patches.

[edit]

Subpages and Channels

Each working group had its own IRC channel for discussion of goals and a separate wiki page, where it could add useful info for the group. See below for groups and their corresponding IRC channel and wiki page.

Group Wiki Page IRC Channel IRC Logs
Docs jQuerySprint/docs #jquery-sprint-docs jQuerySprint/docs/irclog
Demos jQuerySprint/demos #jquery-sprint-demos jQuerySprint/demos/irclog
Dev jQuerySprint/dev #jquery-sprint-dev jQuerySprint/dev/irclog
Test jQuerySprint/test #jquery-sprint-test jQuerySprint/test/irclog
[edit]

Agenda

To coordinate efficiently, we will be around in IRC for both days. Most of the team members will also use Gtalk for direct communication, so feel free to ping Paul (paul.bakaus@gmail.com) or Richard (rdworth@gmail.com) directly. See the Participants List below for team members.

Additionally, we will have three meetings - everyone should attend one of the first two if possible, because this is where we'll speak about the goals for the day.

[edit]

Kick-off Meeting: March 14th, 9:00 am EDT / 14:00 GMT+1

(IRC log)

  • Welcome/Introductions
  • Reminders
    • You'll need a trac account: http://dev.jquery.com. This is for filing tickets and patches
    • You'll need a wiki account: http://docs.jquery.com. This is for documentation, and also the sprint page(s), which we'll use to keep status updates, esp. for folks who join for an hour here or there
    • We recommend the use of a paste site, such as http://paste.pocoo.org/. It uses jquery, is real simple and has great syntax-highlighting. This can be good for those times when you want to share something, but it's not something so big/ready you'd attach to a ticket.
  • Thanks for everyone who signed up and is here. We have 26 people signed up on the wiki page, and people volunteered to help in a number of areas
    • We created 4 teams - docs, demos, dev, test
    • Lots of people are on multiple teams, that's cool
    • Each team will have a facilitator, a sub-page on the wiki, and their own irc channel. This will hopefully keep the noise down in this channel, and on the main sprint wiki page, which should be used for general stuff
    • We really want each team (and not just the facilitator) to take ownership of your team wiki page. If someone walks in here and says, "Hey, I've got 2 hrs. What's happening? What can I do?" The main wiki page should give them some general info, and if they want to jump into testing (for example), the testing page should tell them what's happened already, what's happening now, low hanging fruit, what's coming up etc.
  • Docs Team (facilitator: Richard)
    • Responsible for updating,correcting and adding documentation for each plugin in http://docs.jquery.com/UI
    • We had an API rehaul recently. We need to make sure all the plugins got updated correctly+completely+consistently. That goes for the docs as well.
    • The docs team will finish and then utilize a new page: http://docs.jquery.com/UI/Guidelines, then make sure each plugin is fully documented.
    • Docs is also about more than just writing the docs, it's about testing the api. Does it make sense? Is it clear? Is it jQuery-like ( semantically easy, to the point, short)
  • Demos Team (facilitator: Eduardo)
    • Responsible for creating good demos for each plugin
    • Will work on two demo pages for every plugin: one functional demo and one real-world demo. The functional demo page should give the user an overview of all functionality of the specific plugin, while the real-world demo should show a real world scenario (example: shopping cart).
    • Also create a easy template every functional demo page should use at least, which is completely dependan upon stylesheets, so it can later be reused by the new upcoming UI site.
  • Dev Team (facilitator: Paul)
    • Responsible for fixing any issues that come up - they will mostly use the bug tracker http://dev.jquery.com/
    • In jQuery's bugtracker at http://dev.jquery.com/report/19, we have 73 current open bugs for UI which need to be adressed by the dev's
    • Also, the dev group will have to fix any further upcoming issues coming from the testing group
    • Additionally, the dev group is responsible for doing logical API changes proposed by the testing group (as Richard explained earlier) and specifically, there are a couple of features not working right now that need to be adressed as well.
  • Test Team (facilitator: Richard)
    • Responsible for creating unit tests for each of the plugins and of course for testing the components themselves and reporting possible issues to the bugtracker
    • This group has some very crucial work for this sprint.
    • The goal is to have good unit test coverage (90%?) of all ui plugins. This is critical so that the dev team can make changes, especailly api constistency type changes, across modules. Also, so that the test team can test on all supported browsers, all the while minimizing/detecting regressions.
    • Example unit test script: http://dev.jquery.com/view/trunk/ui/tests/uiTest.dialog.js
    • Example unit test page: http://dev.jquery.com/view/trunk/ui/tests/uiTest.dialog.html
  • Other Notes
    • Please feel free to join any of the for groups - you can also switch groups later on.
    • We want this to be fun and efficient. We're just breaking things up to keep the noise down a bit
[edit]

Status Meeting: March 15th, 9:00 am EDT / 14:00 GMT+1

  • Welcome
    • Here's something to get you "RUMBLING AGAIN" http://www.youtube.com/watch?v=eQ2UVRLBkTs
    • Thanks for the great turn out so far, keep it coming.
    • We hit the ground running, got split up into focused groups, started updating the wiki, and creating and closing tickets right and left.
  • Docs Team (facilitator: Richard)
    • Progress Report: We polished up the new UI/guidelines wiki page, now we're ploughing ahead with reviewing+updating the documentation for each plugin, ensuring completeness and consistency with UI/guidelines, the unit tests, and the code.
    • Today: Make sure the API is totally covered, and then to add more description in parts, so it's more than just an API reference. It should help a user understand what the plugin is, how it's designed, and how to use it; In other words, your mum/dad/grandpa/grandma should be able to understand it.
  • Demos Team (facilitator: Eduardo)
    • Progress Report: We managed to build a working template for functional demos as well as a couple of real world demos like an image cropper.
    • Today: Create one functional demo for every plugin and one real-world demo.
  • Dev Team (facilitator: Paul)
    • Progress Report: We managed to close dozens of issues that were either already solved long ago or yesterday. We also had great discussions about callbacks, namespaces and options, and now there is a much cleaner API then even before.
    • Today: Fix all outstanding bugs in trac, but the test team's goal is to make that very hard ;)
  • Test Team (facilitator: Richard)
    • Progress Report: We're writing complete unit tests for each module. Dialog is 95%, draggables is 75%. The others are just getting started. If someone's not sure what they might do today, we could really use some help with writing and running tests in all supported browsers.
    • Today: Writing and running unit tests, in all browsers. An additional one today will be to test each plugin without a theme, that is, each UI plugin should be functional even if there is no theme (such as flora) present.
[edit]

Wrap-Up Meeting: March 15th, 6:00 pm EDT / 23:00 GMT+1

  • Welcome
    • We're not stopping, just doing a final status update; That said, the sprint will end when the last person stops.
    • We want to keep the momentum even after this weekend.
    • Thank you all so much for all your help, hard work, and devotion. What a great job.
    • A couple quick notes about some big changes today
      • Most parts of dimensions we were using were moved into the core today.
      • Added ui.base.js, a new base for UI that includes all kinds of useful helper functions previously found in ui.mouse.js and the last two missing functions from dimensions (scroll functions and position) stripped down for UI.
      • So as a big update for every UI developer, you now can/should remove dimensions, and include ui.base.js instead at top.
      • All images/icons etc. whether for themes or demos must be MIT/GPL. CC (creative commons) and only GPL are not compatible.
      • There's a new UI logo and jQuery logo coming.
  • Docs Team (facilitator: Richard)
    • we did a little more touch-up work on UI/Guidelines and I know others started diving into individual plugins to make sure they're all done. It's pretty labor-intensive at this point, since the docs are all there, it's the fine-tuning and double-checking. We need to do some final review of some closed tickets and make sure they made it into docs.
    • Thanks: Big thanks to davidserduke, xover, scott_gonzalez, kswedberg.
  • Demos Team (facilitator: Eduardo)
    • Although I have to admit that I simply didn't have the time yet to review all the new real world demos, I'm amazed by the creativity and efforts spend in this area.
    • Thanks: Eduardo did a great job setting up a template for functional demos (he was up till 6 am yesterday, slept 4 hours now - he's today's jQuery Rocky!), and everyone else worked on great real-world demos that can later be reused on our new upcoming homepage.
  • Dev Team (facilitator: Paul)
    • We managed to close 15+ issues at this point, and countless other issues we found that were not in the tracker, We also had great insightful discussions that lead to decisions to make the API a little bit more jquery-like and logical. Finally, as already pointed out, the biggest change is the movement of outerWidth, outerHeight, innerWidth.
    • Thanks: Thank you so much everyone for contributing your time and ideas to all the code here - together.
  • Test Team (facilitator: Richard)
    • We made some really great strides today. We've got unit test pages for accordion, dialog, draggables, resizables, selectables, and slider.
    • Thanks: Big thanks to ThrushAAX and digitalspaghetti! You rocked and provided some great feedback on the new UI unit test suite
[edit]

Goals

We already have a list of goals set up that should be achieved during the sprint to make it a full success:

  • Fix and close all open and upcoming issues in trac
  • Document each UI plugin, ensure that documentation is complete and consistent
  • Update the demos to showcase all plugin features, especially new ones
  • Perform integration tests that combine different plugins as they might be in real applications
  • Test everything using the new user testing system (more details to follow...)


[edit]

Participants

Add your name below if you plan on participating, along with contact info, and what you want to do (testing, documentation, bug fixes, anything)

oaching

Retrieved from "http://docs.jquery.com/JQuerySprint"