90 Matching Annotations
  1. Oct 2016
    1. supported by the project.

      per the github suggestion:

      Any modern Javascript framework, whether the more generic JQuery or interface frameworks like React, Backbone, or Ember, will provide cross-browser support.

    2. Medium:

      This remains an issue but I'm thinking about the conversations around automated patching (what constitutes a good patch). Especially around deletions - if deleting some block is a correct solution but removes functionality, is it a good patch? Here, it's more about correctness in those areas that directly relate to the science question (an algo implementation, for example) or research goal and not expecting 100% bug-free code (that is unrealistic).

      On the research software side (and I'm thinking about the push towards a lot of web-based systems), this medium ground is maybe defining expectations of correctness in the implementation directly aimed at the science/research question (so like the data collection in a Zooniverse project) with a second set of expectations for the other parts of the application (bugs in the tutorial are not critical to the science, necessarily, but raise concerns for adoption and community engagement). This would affect the kinds of specs we might want to see or encourage.

  2. Jul 2016
    1. [If anyone feels that mobile apps should be included, add comments as necessary to this section.]

      We do need something more explicit about mobile apps although it can also be lumped into the follows platform guidelines

  3. Jun 2016
    1. For web applications

      We do not directly cover localization/internationalization. Unclear the scope of that need; however, it might be worth adding (under the unicode statement or instead of) some text for it if localization/internationalization is a stated need of the project or if the stated goals imply that need (if for use in area not predominantly English-speaking, is there any attempt at localization/internationalization?)

    2. 34.Smith, A., Katz, D. & Niemeyer, K. FORCE11 SOFTWARE CITATION PRINCIPLES (Draft). (2016).

      This is temporary until the final is released with a DOI (unknown timeline for that.)

    3. research software journal such as SoftwareX

      one that supports any of the things that makes code reusable instead of just blobs of fortran would be fantastic here. So more examples?

    4. releasing runnable containers

      does not remove the sysadmin requirements but is (often) misinterpreted as such. point people to system resources for upgrades (to know what the thing is to update), give them an understanding of how to handle your app in the container for upgrades.

    5. effective monitoring

      Note re: robots.txt and web service access - it is a blunt instrument in many ways, relying solely on it to block traffic is indicative of load issues.

    6. For web applications and services, provide information regarding uptime, methods for receiving outage notifications, expected response times for responses to support requests.

      how complete do we need to make this list?

    7. deployment requirements

      so if i want to run awesome service framework and i know i need to handle XX requests per minute, i have a better idea if the system can handle that now or if i might have to modify it to meet my needs.

    8. Research Funding Lifecycles

      being revised for the top two levels (overlap in types not funding, ie the bars don't indicate when a grant ends but that a kind of grant could result in projects at different progression stages)

    1. States command names and syntax, says what menus to use, lists parameters and error messages exactly as they appear or should be typed; or provides similarly explicit instructions on how to apply product.

      e.g., cook book

    2. Binary and source packages reference thrid-party code (including

      typo

      auto updating can break other software. From geoscientist perspective these are valuable but shouldn't be a deal breaker for assessment.

    3. Opinions and perspectives are offered only as they relate to the mission of the project, and are clearly identified and put into context.

      larger assessment framework but not necessary for software, would this preclude forum or comments in GitHub issues?

    4. The precision presented in answers to the user is appropriate for the product's algorithm and implementation.

      is this relevant to software? It seems releavnt to data. Not necessarily applicable to all

    5. Preservation/Archiving

      review with documentation for duplication - make statement here for documentation archived with code and meets those doc standards.

    6. Installers are available for all relevant platforms (Windows, OSX, Linux, etc.)

      installers provided for target platforms & target platforms are indicated in the documentation.