jthuma

Please Read Before Creating a Bug or Feature Request

Blog Post created by jthuma on Jan 9, 2016

I am sure there are going to be bugs and new features requested for Tango.  Please use this as a guideline prior to issuing a bug or a new feature request.  It will help me in determining if the bug or feature is something important and in demand.


First lets discuss what is a bug and what is a feature request.

 

What is a BUG:

 

A bug is a defect.  It is an error, flaw, failure or fault in a computer program or system that causes it to produce an incorrect or unexpected result, or to behave in unintended ways.

 

Some good practices for issuing bugs: 

 

Be specific. If you can do the same thing two different ways, state which one you used. "I selected Load" might mean "I clicked on Load" or "I pressed Alt-L". Say which you did. Sometimes it matters.

 

Be verbose. Give more information rather than less. If you say too much, the programmer can ignore some of it. If you say too little, they have to come back and ask more questions. One bug report I received was a single sentence; every time I asked for more information, the reporter would reply with another single sentence. It took me several weeks to get a useful amount of information, because it turned up one short sentence at a time.

 

Be careful of pronouns. Don't use words like "it", or references like "the window", when it's unclear what they mean. Consider this: "I started FooApp. It put up a warning window. I tried to close it and it crashed." It isn't clear what the user tried to close. Did they try to close the warning window, or the whole of FooApp? It makes a difference. Instead, you could say "I started FooApp, which put up a warning window. I tried to close the warning window, and FooApp crashed." This is longer and more repetitive, but also clearer and less easy to misunderstand.

 

Read what you wrote. Read the report back to yourself, and see if you think it's clear. If you have listed a sequence of actions which should produce the failure, try following them yourself, to see if you missed a step.

 

What is a Feature Request:

 

Feature Requests are concrete ideas for implementing new features in or around a software product. Feature Requests can be completely new ideas, or enhancements to existing features. Feature Requests can be implemented by anyone in the community.

 

Some good practices for issuing feature requests:

 

Use a clear title. The more specific something is, the easier it is to understand by us and other readers.

 

One idea per post. You can post multiples, don’t worry. Keeping a post to a single idea insures the follow up communications will be easier to follow.

 

Keep the idea description short and simple. Some inspiration to help you write your description; think about why you want this feature, why it would help you, what you currently have to do since it doesn’t exist already

Outcomes