W3C home > Mailing lists > Public > public-epub3@w3.org > June 2017

Re: [epubcheck] naming and issues conventions

From: Charles LaPierre <charlesl@benetech.org>
Date: Tue, 13 Jun 2017 15:32:10 +0000
To: "Siegman, Tzviya - Hoboken" <tsiegman@wiley.com>
CC: "public-epub3@w3.org" <public-epub3@w3.org>
Message-ID: <2BB07F03-B7F4-49E7-85DE-5A6F59EA78AF@benetech.org>
Hi Tzviya, For unit tests the convention is that every test must start with the word test in lowercase.  Some testing environments require this I believe.

When I have done unit tests using Java we usually had Camel Case with
testSvgNotInSpine
testEduBasics
...

I guess you could go with
test-svn-not-in-spine
test-edu-basics
etc…

I assume that would be fine but never tried that before.

Would be curious to hear others thoughts on this.


Thanks
EOM

Charles LaPierre
Technical Lead, DIAGRAM and Born Accessible
E-mail: charlesl@benetech.org<mailto:charlesl@benetech.org>
Twitter: @CLaPierreA11Y
Skype: charles_lapierre
Phone: 650-600-3301



On Jun 13, 2017, at 8:05 AM, Siegman, Tzviya - Hoboken <tsiegman@wiley.com<mailto:tsiegman@wiley.com>> wrote:

Hello epubcheck TF,

Following up on last week’s meeting, here is a proposed naming convention for test suite files:


1.       lowercase descriptive filenames with hyphens.

2.       Prefixes for dedicated domains.

3.       EPUB Version should NOT be included in file name (some tests apply to multiple versions)



Examples:

  *   svg-not-in-spine describes a file with SVG not in the spine
  *   edu-basic describes an EPUB for Education basic test file
  *   meta-inf-not-in-OPF describes a file that is missing the metainf file in the OPF
  *   mr-collections describes a multiple renditions EPUB with a collection element

Any feedback on this proposal?


When logging issues in GitHub, please try to use explicit references to sections of the specs.

If you signed up for a task at the last meeting<https://github.com/w3c/publ-cg/wiki/epubcheck-TF-meeting-minutes-and-summaries#2017-06-08>, please remember to finish it by the end of the month.

As a reminder, we still need volunteers for the following tasks:
Document changes in GitHub for EPUB 3.0.1 -> 3.1. We have a volunteer for the Packages spec, but there’s more!
Skills required: Familiarity with EPUB and GitHub

Write Marketing copy for pending 4.0.1 maintenance release of epubcheck
Skills required: writing marketing copy for technical people

Cleaning up test suite files for epubcheck
Skills required: EPUB editing and following Romain’s every wish

Thanks,
Tzviya

Tzviya Siegman
Information Standards Lead
Wiley
201-748-6884
tsiegman@wiley.com<mailto:tsiegman@wiley.com>

Received on Tuesday, 13 June 2017 15:33:49 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 19:44:26 UTC