[
https://issues.apache.org/jira/browse/SENSSOFT-203?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Joshua Poore closed SENSSOFT-203.
---------------------------------
Resolution: Fixed
Completed prior to UserALE.js 1.0.0 release
> Address UserALE.js feedback from lewismc
> ----------------------------------------
>
> Key: SENSSOFT-203
> URL: https://issues.apache.org/jira/browse/SENSSOFT-203
> Project: SensSoft
> Issue Type: Task
> Components: UserALE.js
> Affects Versions: UserALE.js 0.1.0
> Reporter: Lewis John McGibbney
> Assignee: Michelle Beard
> Priority: Blocker
> Fix For: UserALE.js 1.0.0
>
> Original Estimate: 4h
> Remaining Estimate: 4h
>
> Hi Folks,
> This is straight from my identical feedback on the dev@ list. Excellent work
> on UserALE.js it is looking very good.
> Lewis
> Some initial questions/feedback/observations
> # The README [0] needs to be updated in several places, this will be obvious
> when you read the README. This will need to be updated.
> # Is the intention to host UserALE.js on some CDN somewhere? I see from [1]
> that the intention is to release the code to NPM and/or Bower... is this work
> in progress (I think it definitely is) and if so is it documented somewhere?
> # It might be worth providing a more detailed description at [2]
> # I would make sure that the JIRA Release Notes [3] are copied over to the
> CHANGELOG.md file [4]. Additionally, I would structure it after the following
> example [5] where essentially the JIRA release report is copied and pasted in
> there, this tends to render nicely in Markdown. Additionally, it looks better
> if the release manager provides a short link to the release report. This can
> be obtained using the URL shortening service at [6].
> # Please make sure to add a DISCLAIMER, a sample can be seen at [7]
> # We need to produce a KEYS file for all SensSoft developers who wish to act
> as release manager and sign release artifacts. They KEYS file can live
> anywhere within/across the SensSoft repositories. An example can be found at
> [8].
> # We need to generate a NOTICE file which essentially details usage and
> appropriate attribution of dependencies consumed within UserALE.js. An
> example can be seen at [9].
> # We should probably generate a Description of a Project (DOAP) file for
> every SensSoft project... however this is not a blocker for a release.
> I think the above represents a minimum degree of feedback that I would like
> to see addressed before we attempt to generate a release candidate for
> UserALE.js.
> If there are ANY questions, please let me know.
> I've raised a JIRA issue for this at [10] which will enable someone(s) to
> track and address the issues.
> Thanks
> [0] https://github.com/apache/incubator-senssoft-useralejs
> [1]
> https://github.com/apache/incubator-senssoft-useralejs/blob/master/README.md
> [2]
> https://github.com/apache/incubator-senssoft-useralejs/blob/master/package.json#L4
> [3]
> https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12320621&version=12339748
> [4]
> https://github.com/apache/incubator-senssoft-useralejs/blob/master/CHANGELOG.md
> [5]
> https://raw.githubusercontent.com/apache/incubator-joshua/master/CHANGES.md
> [6] https://s.apache.org/
> [7] https://github.com/apache/incubator-joshua/blob/master/DISCLAIMER.txt
> [8] https://github.com/apache/incubator-joshua/blob/master/KEYS
> [9] https://github.com/apache/incubator-joshua/blob/master/NOTICE.txt
> {code}
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
