Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [jakarta.ee-spec.committee] naming convention for specification documents?

I don't think we need to enforce the naming convention, but I do like to avoid gratuitous differences.  :-)

I don't have a strong preference myself.  I'm hoping a consensus will emerge.


Kevin Sutter wrote on 7/3/19 7:52 PM:
Some of the initial cleanup I did for the Platform spec was rename the specs that were originally contributed:
https://github.com/eclipse-ee4j/jakartaee-platform/tree/master/specification

I followed a naming convention along lines of an option 2a (mixed case for WebProfile):

Platform-spec-1.0.pdf
WebProfile-spec-1.0.pdf

But, the Bill's spec-template followed a clear lowercase naming convention (option 1):

wombat-spec-1.0.pdf

I'm happy with either approach (option 1, 2, or 2a).  I don't know that we have to enforce the case of the name.  I do not care for option 3, 4, or 5.

But, to be very clear on the content, do we also need to preface the name with "jakarta-" or "Jakarta-" (again, no preference on the case)?

Jakarta-Platform-spec-1.0.pdf
Jakarta-WebProfile-spec-1.0.pdf
jakarta-wombat-spec-1.0.pdf

The doodle poll could get quite complicated...  :-)  

---------------------------------------------------
Kevin Sutter
STSM, MicroProfile and Jakarta EE architect
e-mail:  sutter@xxxxxxxxxx     Twitter:  @kwsutter
phone: tl-553-3620 (office), 507-253-3620 (office)    
LinkedIn:
https://www.linkedin.com/in/kevinwsutter



From:        Bill Shannon <bill.shannon@xxxxxxxxxx>
To:        Jakarta specification committee <jakarta.ee-spec.committee@xxxxxxxxxxx>
Date:        07/03/2019 06:02 PM
Subject:        [EXTERNAL] [jakarta.ee-spec.committee] naming convention for specification        documents?
Sent by:        jakarta.ee-spec.committee-bounces@xxxxxxxxxxx




What should be the naming convention for specification documents?

1. wombat-spec-1.0.pdf
2. Wombat-spec-1.0.pdf
3. Wombat-Spec-1.0.pdf
4. WombatSpec-1.0.pdf
5. Something else
_______________________________________________
jakarta.ee-spec.committee mailing list
jakarta.ee-spec.committee@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/jakarta.ee-spec.committee





_______________________________________________
jakarta.ee-spec.committee mailing list
jakarta.ee-spec.committee@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/jakarta.ee-spec.committee


Back to the top