From f57106a825b9a2ae6f0b1660bc6a1a9b687d6c34 Mon Sep 17 00:00:00 2001 From: David Hassell Date: Thu, 20 Jan 2022 14:10:46 +0000 Subject: [PATCH 1/5] UGRID rules --- rules.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/rules.md b/rules.md index 279959464..183a2e5bb 100755 --- a/rules.md +++ b/rules.md @@ -5,13 +5,13 @@ title: Rules # Rules for CF Conventions Changes -

New proposals are to be made in github issues using the template, including verbatim changes proposed to the text of standard document and the conformance document.

+

New proposals are to be made in GitHub issues using the template, including verbatim changes proposed to the text of standard document and the conformance document.

A member of the conventions committee, or another suitably qualified person, volunteers to moderate the discussion. If no-one volunteers, the chairman of the committee will ask someone to do it.

-

The discussion takes place on github issues and all may participate.

+

The discussion takes place on GitHub issues and all may participate.

-

The moderator periodically summarises discussion on github, keeps it moving forward and tries to achieve a consensus. It is expected that everyone with an interest will contribute to the discussion and to achieving a consensus during this stage. During the discussion, if an objection is raised, answered and not reasserted, the moderator will assume the objection has been dropped. However, since consensus is the best outcome, it will be helpful if anyone who expresses an objection explicitly withdraws it on changing their mind or deciding to accept the majority view.

+

The moderator periodically summarises discussion on GitHub, keeps it moving forward and tries to achieve a consensus. It is expected that everyone with an interest will contribute to the discussion and to achieving a consensus during this stage. During the discussion, if an objection is raised, answered and not reasserted, the moderator will assume the objection has been dropped. However, since consensus is the best outcome, it will be helpful if anyone who expresses an objection explicitly withdraws it on changing their mind or deciding to accept the majority view.

The moderator is encouraged to organize conference calls and/or webex-type interactions if this might help resolve an issue more quickly.

@@ -27,15 +27,15 @@ title: Rules

Not near consensus: No change to standard.

-

The github issue is then closed by the moderator stating the outcome.

+

The GitHub issue is then closed by the moderator stating the outcome.

If the change is accepted, the standard document should be updated, the CF convention version number incremented, and the conformance document updated.

The author of the proposal should be added to the list of contributing authors of the CF convention.

-

If the change, once implemented in the conventions, subsequently turns out to be materially flawed, meaning that data written following the convention could be somehow erroneous or ambiguous, a github issue should urgently be opened to discuss whether to revoke the change. If this is agreed by a majority of the committee, a new version of the conventions will be prepared immediately, with the second digit of the version number incremented, and will be recommended to be used instead of the flawed version. The flawed version will be deprecated by a statement in the standard document and the conformance document. However, any data written with the flawed version will not be invalidated, although it may be problematic for users. Errors or lack of clarity in wording, when the convention itself is not at fault, can be corrected by defect tickets on the usual schedule.

+

If the change, once implemented in the conventions, subsequently turns out to be materially flawed, meaning that data written following the convention could be somehow erroneous or ambiguous, a GitHub issue should urgently be opened to discuss whether to revoke the change. If this is agreed by a majority of the committee, a new version of the conventions will be prepared immediately, with the second digit of the version number incremented, and will be recommended to be used instead of the flawed version. The flawed version will be deprecated by a statement in the standard document and the conformance document. However, any data written with the flawed version will not be invalidated, although it may be problematic for users. Errors or lack of clarity in wording, when the convention itself is not at fault, can be corrected by defect tickets on the usual schedule.

-

All versions of the standard and conformance document should be kept available online, with their github issues and a history of changes.

+

All versions of the standard and conformance document should be kept available online, with their GitHub issues and a history of changes.

## Additional rules relating to the CF data model @@ -51,4 +51,20 @@ Otherwise an attempt must be made to modify the proposal so that its new featur If the proposal cannot be acceptably modified to conform to the existing data model, then the data model will need to be modified to accommodate the new features. If the data model may be extended or generalised in some way that allows the new features but does not affect its existing constructs and relationships, the proposal is considered backwards compatible. This is the preferred solution. -Any changes to the data model must be described verbatim as part of the proposal discussion, including any modified or new data model diagrams. However, to facilitate the progress of a proposal that requires data model changes, it is sufficient for the general nature of the data model modifications to be identified, on the understanding that the data model text will be updated in detail at a later date, possibly after the proposal has been accepted. \ No newline at end of file +Any changes to the data model must be described verbatim as part of the proposal discussion, including any modified or new data model diagrams. However, to facilitate the progress of a proposal that requires data model changes, it is sufficient for the general nature of the data model modifications to be identified, on the understanding that the data model text will be updated in detail at a later date, possibly after the proposal has been accepted. + +## Additional recommendations relating to UGRID + +CF incorporates named versions of the UGRID conventions without +redefining them in the CF conventions document, i.e. CF formally +refers to the UGRID conventions document for its description of mesh +topologies. UGRID has its own governance that is independent of the +rules governing the CF conventions, and itt is therefore the joint +responsibility of the CF and UGRID communities to ensure that changes +to one convention are mutually agreeable to the other. However, in the +unlikely and highly undesirable event that a non-negotiable change to +one convention is incompatible with the other convention, then this +may be resolved either by restricting which versions of UGRID are +allowed in CF; or else rewriting UGRID into the CF conventions +document, including any required compatibility changes, thereby +breaking the formal dependence on the external UGRID conventions. \ No newline at end of file From 4f202f5d22a446fc628440a1db10d736c6b04df3 Mon Sep 17 00:00:00 2001 From: David Hassell Date: Thu, 20 Jan 2022 14:11:26 +0000 Subject: [PATCH 2/5] UGRID rules --- rules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rules.md b/rules.md index 183a2e5bb..11b907acf 100755 --- a/rules.md +++ b/rules.md @@ -59,7 +59,7 @@ CF incorporates named versions of the UGRID conventions without redefining them in the CF conventions document, i.e. CF formally refers to the UGRID conventions document for its description of mesh topologies. UGRID has its own governance that is independent of the -rules governing the CF conventions, and itt is therefore the joint +rules governing the CF conventions, and it is therefore the joint responsibility of the CF and UGRID communities to ensure that changes to one convention are mutually agreeable to the other. However, in the unlikely and highly undesirable event that a non-negotiable change to From 8c690f346edd4353e0501c2860da16025e8b9ab8 Mon Sep 17 00:00:00 2001 From: David Hassell Date: Thu, 20 Jan 2022 14:12:19 +0000 Subject: [PATCH 3/5] UGRID rules --- rules.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/rules.md b/rules.md index 11b907acf..91c38adeb 100755 --- a/rules.md +++ b/rules.md @@ -63,8 +63,9 @@ rules governing the CF conventions, and it is therefore the joint responsibility of the CF and UGRID communities to ensure that changes to one convention are mutually agreeable to the other. However, in the unlikely and highly undesirable event that a non-negotiable change to -one convention is incompatible with the other convention, then this -may be resolved either by restricting which versions of UGRID are -allowed in CF; or else rewriting UGRID into the CF conventions -document, including any required compatibility changes, thereby -breaking the formal dependence on the external UGRID conventions. \ No newline at end of file +one convention is incompatible with the other convention then this may +be resolved either by restricting which versions of UGRID are allowed +in CF; or else (as a last resort) rewriting UGRID into the CF +conventions document, including any required compatibility changes, +thereby breaking the formal dependence on the external UGRID +conventions. \ No newline at end of file From ae951d5be7501f99e8d49b41bf4388d3fbc480a0 Mon Sep 17 00:00:00 2001 From: David Hassell Date: Thu, 20 Jan 2022 14:14:03 +0000 Subject: [PATCH 4/5] UGRID rules --- rules.md | 17 +++-------------- 1 file changed, 3 insertions(+), 14 deletions(-) diff --git a/rules.md b/rules.md index 91c38adeb..e9785ffec 100755 --- a/rules.md +++ b/rules.md @@ -55,17 +55,6 @@ Any changes to the data model must be described verbatim as part of the proposal ## Additional recommendations relating to UGRID -CF incorporates named versions of the UGRID conventions without -redefining them in the CF conventions document, i.e. CF formally -refers to the UGRID conventions document for its description of mesh -topologies. UGRID has its own governance that is independent of the -rules governing the CF conventions, and it is therefore the joint -responsibility of the CF and UGRID communities to ensure that changes -to one convention are mutually agreeable to the other. However, in the -unlikely and highly undesirable event that a non-negotiable change to -one convention is incompatible with the other convention then this may -be resolved either by restricting which versions of UGRID are allowed -in CF; or else (as a last resort) rewriting UGRID into the CF -conventions document, including any required compatibility changes, -thereby breaking the formal dependence on the external UGRID -conventions. \ No newline at end of file +CF incorporates named versions of the UGRID conventions without redefining them in the CF conventions document, i.e. CF formally refers to the UGRID conventions document for its description of mesh topologies. +UGRID has its own governance that is independent of the rules governing the CF conventions, and it is therefore the joint responsibility of the CF and UGRID communities to ensure that changes to one convention are mutually agreeable to the other. +However, in the unlikely and highly undesirable event that a non-negotiable change to one convention is incompatible with the other convention then this may be resolved either by restricting which versions of UGRID are allowed in CF; or else (as a last resort) rewriting UGRID into the CF conventions document, including any required compatibility changes, thereby breaking the formal dependence on the external UGRID conventions. \ No newline at end of file From c4acba5d9ac365af2ae1c76b532d43eb1d68a944 Mon Sep 17 00:00:00 2001 From: David Hassell Date: Thu, 20 Jan 2022 14:37:00 +0000 Subject: [PATCH 5/5] UGRID rules --- rules.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/rules.md b/rules.md index e9785ffec..d9514674a 100755 --- a/rules.md +++ b/rules.md @@ -57,4 +57,5 @@ Any changes to the data model must be described verbatim as part of the proposal CF incorporates named versions of the UGRID conventions without redefining them in the CF conventions document, i.e. CF formally refers to the UGRID conventions document for its description of mesh topologies. UGRID has its own governance that is independent of the rules governing the CF conventions, and it is therefore the joint responsibility of the CF and UGRID communities to ensure that changes to one convention are mutually agreeable to the other. -However, in the unlikely and highly undesirable event that a non-negotiable change to one convention is incompatible with the other convention then this may be resolved either by restricting which versions of UGRID are allowed in CF; or else (as a last resort) rewriting UGRID into the CF conventions document, including any required compatibility changes, thereby breaking the formal dependence on the external UGRID conventions. \ No newline at end of file + +In the unlikely and highly undesirable event that a non-negotiable change to one convention is incompatible with the other convention then this may be resolved either by restricting which versions of UGRID are allowed in CF; or else (as a last resort) rewriting UGRID into the CF conventions document, including any required compatibility changes, thereby breaking the formal dependence on the external UGRID conventions. \ No newline at end of file