#summary A guide on how to best file an issue for the developers.
#labels Documentation-Misc,Featured

= Introduction =

When you file an issue for us to look at, regardless of whether it is a bug, a feature request or something else entirely, please be as specific as possible. The more specific you are from the get-go, the more likely we are to know exactly what you mean. This allows us to hopefully quickly and efficiently swoop in and deal with the matter.


= On Features =

K2 was designed to solve a whole range of issues for people. And for that, it boasts a good deal of features as it is. Contrary to popular belief however, we are very careful with adding new features into the K2 core.

After all, that is what the WordPress plugin system was built for. And with the versatility of the sidebar modules and WordPress widgets, there is often no reason to incorporate things directly into the core K2 files.

That said, we _are_ open to suggestions, _especially_ if they are thought through.

So before you file that feature request, ask yourself these questions:

  * Is this really something K2 needs?
  * Could this be a plugin instead?
  * Can this be done with sidebar modules?
  * Can this be done with CSS alone?

And so on.

If you still think we should take a look, by all means, send it right on over and we'll have a look at it.


= On Bugs =

Bugs are things that don't work as expected. We of course aim to have no bugs at all in the system, but gosh-darnit, the buggers are hard to kill.

If you encounter a bug of some sort while using K2, the sooner your report it to us, the faster we can nail that sucker to the wall.

But it's not just about speed though, it's also about precision. The K2 developers are not unlike a highly specialized SEAL team, capable of working behind enemy lines for days at a time on next to no food (though some caffeine is needed), solving impossible missions.

Therefor, the more precise your coordinates are, the more likely we are to eliminate the problem.

Here are some guidelines:

== Code Contributions ==

We _love_ patches to fix bugs. Plain text in the bug report or attached diff's, it doesn't matter to us, we're just happy to be helped out. So if that is at all possible, it is likely to save us some time out of our already busy lives.

== Show Us the Problem! ==

If you are filing a bug report, we much prefer if you're able to point us to a site where the problem is easily observable. Furthermore, the 'cleaner' your install of K2 is, the better.

Sites running variations of K2, that is, themes branched in some manner from K2, are usually not of much help.

== Screenshots ==

In addition to your site, or in place of, we also very much prefer screenshots of your problem, if applicable. That way, if we are unable to duplicate the problem, at least we know what to work from.

== Software Versions ==

Here's a good checklist:

  * What version or revision of K2 are you using?
  * What version or revision of WordPress?
  * What browsers (with versions) have you tested this in?
  * What version of PHP and mySQL is your server running?
  * Are you running any plugins that might interfere with K2?


= In Conclusion =

Are you still reading? Go catch some bugs for us to fry!