search

oasis-open / tosca-community-contributions

OASIS TC Open Repository: Manages TOSCA profiles, tests, and templates that are maintained by the TOSCA community. They are intended to be used as examples to help developers get started with TOSCA and to test compliance of TOSCA implementations with the standard.
https://github.com/oasis-open/tosca-community-contributions
Apache License 2.0
39 stars 25 forks source link

Contribution guidelines are inconsistent #158

Open pmjordan opened 11 months ago

pmjordan commented 11 months ago

CSD06 has an opening section headed 'Status' which details how TC members and the public should comment on the document. The text has been copied from V1.3 and does not take account of our current use of tosca-community-contributions on github.

The CONTRIBUTING.md document of tosca-specs invites contributions to that repo and does not mention the use of tosca-community-contributions. It also points to the OASIS TC mailing list pages.

If the use of tosca-community-contributions is to continue after publication of V2.0 then that should be stated in the document and it's repo. If not then the CONTRIBUTING.md from tosca-community-contributions should be copied to tosca-specs in preparation for tracking issues on that repo.

lauwers commented 11 months ago

the tosca-community-contributions repo is a community forum only and in theory should not be used for work on the specification. I believe the text in the document correctly reflects OASIS's policies. However, OASIS is currently also reviewing these policies, and we should encourage the use of github rather than email for commenting on the spec. In that case, we should use https://github.com/oasis-tcs/tosca-specs/issues rather than this repository.

pmjordan commented 11 months ago

Then let's amend the CSD to point to https://github.com/oasis-tcs/tosca-specs/issues as the primary feedback channel but that comments may also be submitted using the prevailing OASIS method.

lauwers commented 10 months ago

It appears that the new template that was used for the Markdown version of the spec no longer includes that language that was in CSD06. Instead, the github repository has a separate file (in https://github.com/oasis-tcs/tosca-specs/blob/working/CONTRIBUTING.md) that spells out where feedback should be submitted. It does point to the github issues mechanism as the primary channel.

pmjordan commented 10 months ago

Yes I saw and mentioned https://github.com/oasis-tcs/tosca-specs/blob/working/CONTRIBUTING.md in my original issue report. I agree that that will be the route that people would expect to use for comments on version 2 once it has been published and I agree that is the route which we should promote. However I still think there is an inconsistency; line 55 Instructs users to submit comments via the OASIS mailing list. I think that line should be either be removed or revised to point at CONTRIBUTING.md