[v2] Technical doc, structured todo-list

[Alexandre Mutel]

Where can I put some technical doc and in what kind of format on svn?

 

Also, I’m not completely happy about using only the “tracking issue” to keep a trace of things that should be done, refactored...etc because this view is completely flat, not structured per component, lacking inter-dependency and a global structured view of what’s going on. Any idea how we could improve this?

[Josh Petrie]

Where can I put some technical doc and in what kind of format on svn?

We don't really have a place for that kind of documentation at the moment; I'd suggest checking it in under v2/Documentation. Please make sure it's a file that can be viewed/edited easily by anybody (i.e., not a Word document or similar). Plain text is probably most ideal, or something using Markdown syntax, at least for the time being.

Also, I’m not completely happy about using only the “tracking issue” to keep a trace of things that should be done, refactored...etc because this view is completely flat, not structured per component, lacking inter-dependency and a global structured view of what’s going on. Any idea how we could improve this?

I'm not sure what you mean. Google Code's issue tracker supports task dependencies via the "blocked on" field and interlinking by parsing out references to issue numbers and making them hyperlinks to the issue in question. It also integrates with SVN in that issues can be automatically resolved by a commit if the commit contains an appropriately-formatted string ("resolves issue #32" for example). Issues can be tagged, assigned to milestones, and filtered based on those tags. Finally, the issue tracker is globally available to anybody. It's pretty much met all of our needs so far -- it's certainly not as customizable as something like FogBugz or Bugzilla, but quite frankly we've always considered those systems to be pretty cumbersome because it's so easy to lose your signal in all the configuration, and spend more time doing meta-work on issues themselves rather than the real work the issue represents.

What would you propose as an alternative?

-- jmp

[@lx]

>
> What would you propose as an alternative?

Actually, I don't know... whatever the solution would anyway imply to
duplicate the info in the issue tracker, so It's probably not usable.
If I had to fill the issue tracker with all pending issues in v2,
well, It would contains several pages.

Does the tag can be used to tag part of the components in v2 : like
the generator, the parser, and at some point, all packages Direct3D9,
Direct3D10...?

For example, after the generator and parser will be "finalized" and
cleaner, there will be a bunch of renaming issues, handmade code to
implement on each sub-project. Having a way to quickly filter, or at
least, see directly the names in the subject would be helpful, no?

[Josh Petrie]

The tags can be arbitrary, but unless I or one of the other leads enter tags into a set of 'recommended' tags, Google Code will warn you that you're using an uncommon tag. You can search based on tags: http://code.google.com/p/slimdx/issues/list?can=2&q=label:V2

Remember you can also filter the issues based on content, so all you'd need to do is write a good summary for most issues and that would probably cover it. "Parser should do this," "parser should do that," should allow you to easily restrict your view to those pertaining to the parser: http://code.google.com/p/slimdx/issues/list?can=2&q=parser%20label:V2 -- this even catches bugs that probably related to the parser but somebody forgot to tag, for example.

We haven't really found a compelling need to employ a wide variety of tags right now, as its only been extra overhead for little benefit. Approximately how many issues are you thinking of entering, here?

-- jmp

--
You received this message because you are subscribed to the Google Groups "slimdx-devel" group.
To post to this group, send email to slimdx...@googlegroups.com.
To unsubscribe from this group, send email to slimdx-devel...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/slimdx-devel?hl=en.