Rules for papercuts

Minor issues with the Ogre API that can be trivial to fix
Locked
CABAListic
OGRE Retired Team Member
OGRE Retired Team Member
Posts: 2903
Joined: Thu Jan 18, 2007 2:48 pm
Contact:

Rules for papercuts

Post by CABAListic » Mon Dec 20, 2010 1:03 am

What is a papercut?

A papercut is a minor issue with the Ogre API, like a missing function that you were expecting, an inconsistently named function, misleading or incorrect documentation, etc. Basically anything that slightly annoyed you at the time you had to figure it out, but not such a major issue that it kept you from doing what you wanted to do. A papercut should be trivial to fix.

Reporting papercuts

Please report any papercut you encountered in our bugtracker. Create a new report and prefix the title with "[Papercut]". If you feel there is need for a discussion about a proposed change, then open a thread in this forum and link to the corresponding report in the tracker.

Resolving papercuts

We want to get rid of as many papercuts as possible for the next major Ogre release (Byatis 1.8). As such, we will try to regularly squash any reported papercuts in batches. Your report is immensely helpful, as it makes us aware of the issue and also documents it in a place where it's easy to find and doesn't get lost.
0 x

User avatar
spacegaier
OGRE Team Member
OGRE Team Member
Posts: 4291
Joined: Mon Feb 04, 2008 2:02 pm
Location: Germany
x 2
Contact:

Re: Rules for papercuts

Post by spacegaier » Sun Jan 02, 2011 10:43 pm

I just announced the initiative on the http://www.ogre3d.org front-page to gain even more momentum and make our tracker burst eventually :).

http://www.ogre3d.org/2011/01/02/papercut-initiative

So, keep the papercuts coming!
0 x
Ogre Admin [Admin, Dev, PR, Finance, Wiki, etc.] | BasicOgreFramework | AdvancedOgreFramework
Don't know what to do in your spare time? Help the Ogre wiki grow! Or squash a bug...

User avatar
jacmoe
OGRE Retired Moderator
OGRE Retired Moderator
Posts: 20570
Joined: Thu Jan 22, 2004 10:13 am
Location: Denmark
Contact:

Re: Rules for papercuts

Post by jacmoe » Thu Jan 20, 2011 12:40 am

A papercut should be trivial to fix, otherwise it is not a papercut.
So, what is "easy to fix"?
A bug is easy to fix if it can be fixed by one person in one day. In practice, one or more people might work together over the course of a week to fix a paper cut, but if one competent developer cannot fix the bug in a single day, the bug cannot be considered a valid paper cut.

Many bugs become trivially fixable right before they are fixed. If a bug appears too complex to be considered a paper cut at first, it may turn out to be trivially fixable if it has a working patch that could be cleaned up and merged by one person in one day.
0 x
/* Less noise. More signal. */
Ogitor Scenebuilder - powered by Ogre, presented by Qt, fueled by Passion.
OgreAddons - the Ogre code suppository.

Locked