Code snippets in JIRA for minor new features

[Everett Toews <ev...@RACKSPACE.COM>]

Hi All,

I'd like to encourage everyone to include code snippets in JIRA for how to use minor new features that you've developed.

For example, issues like:

https://issues.apache.org/jira/browse/JCLOUDS-381
https://issues.apache.org/jira/browse/JCLOUDS-416

would really benefit from this.

To add code in comments do something like:

{code:java}
TemplateOptions options = NovaTemplateOptions.Builder
    .keyPairName(keyPair.getName());

Template template = computeService.templateBuilder()
    .locationId(ZONE)
    .osDescriptionMatches(".*Ubuntu 12.04.*")
    .hardwareId(zoneAndId.slashEncode())
    .options(options)
    .build();
{code}

This lets users know exactly how to use the feature. 

Requiring documentation and examples for new features are outside the scope of this email. Let's start small by just including snippets in issues.

Thanks,
Everett

Re: Code snippets in JIRA for minor new features

[Andrew Phillips <ap...@qrmedia.com>]

> I'd like to encourage everyone to include code snippets in JIRA for   
> how to use minor new features that you've developed.

Sounds useful not just for newly developed features, but also in  
feature *requests* if users have an idea of the kind of code they'd  
*like* to use.

I'm just curious, though, how many users would actually be able to  
find their way to our JIRA (as opposed to, say, the jclouds site or  
the Javadocs) for code examples.

ap