MetroCS / QualityToolsForBlueJ

BlueJ extension to integrate quality assessment tools

GNU Lesser General Public License v3.0

0 stars 42 forks source link

[UserStory] Production jar should be named QualityTools.jar #138

Closed jody closed 4 years ago

jody commented 4 years ago

User Story

Essential components

[x] Title describes the story
[x] Stakeholder type is identified
[x] Outcome is described
[x] Rationale is explicit
[x] Acceptance criteria are verifiable and from the perspective of the stakeholder

Story

As a {user, educator} I want the root name of the product jar to be QualityTools
so that I have a consistent way to identify the product as approved by the product owner.

Acceptance Criteria

The product jar file is named QualityTools.jar

Related Information

Naming development jar files: #149

shadycloud commented 4 years ago

I would like to give my opinion that I think we should include the version number in our file name.

jody commented 4 years ago

my opinion that I think

It would be useful to hear rationales that address the relative merits of (a) restricting the product to only one of the two options in this story, and if so restricted (b) which of the two options is to be adopted.

In terms of matching convention...

Neither the BlueJ application nor the supplied submitter extension include the release number in their file names.
Almost all of the extensions available through the BlueJ Extensions page do not have a version number in the jar file name.
Some of the BlueJ Extensions do have release numbers (versions) in their jar file names, including PatternCoder and Checkstyle.

shadycloud commented 4 years ago

I am speaking from my experience of linux distros. In my experience, it has been great help to see the version number in the file name.

shadycloud commented 4 years ago

shadycloud commented 4 years ago

I got that straight from the BlueJ site.

shadycloud commented 4 years ago

I think there is something to be adopted from one of the most popular Java extensions including the version number in it's file name.

jody commented 4 years ago

I got that straight from the BlueJ site. It appears that you may be suggesting that the extension be packaged in a folder and that such folder include the version number in its name. (That is the case with the BlueJ application, which includes version numbering of the distribution folder, but does not include the version number in the name of the actual product file.)

Please open a new User Story that describes the nature of extension packaging.

jody commented 4 years ago

Reduced scope of this user story to naming of production jars. Created new user story #149 for naming of development jars.

jody commented 4 years ago

Copy/Rename task, dist, added to build.gradle https://github.com/MetroCS/QualityToolsForBlueJ/blob/99461c267764af028913cec80715cce2e088b6cd/build.gradle#L73-L82