⇐ ⇒

[CF-metadata] Discussion of changes?

From: Chris Barker <chris.barker>
Date: Thu, 8 Nov 2018 09:52:47 -0800

Hi all,

Despite the recent problem with gitHub issues getting mirrored here, It
seems posting a gitHub issue is not enough to get folks involved :-)

And by the way, where ARE we with respect to gitHub vs TRAC at this point
???

This page:

http://cfconventions.org/discussion.html

Talks about TRAC, and makes no mention of gitHub...

Back to the issue:

I recently posted an issue on gitHub:

https://github.com/cf-convention/cf-conventions/issues/150

With regards to being clear about the workflow for making changes to CF.

In particular, I am suggesting that CF adopt an "Enhancement Proposal"
(CEP) process for changes that require significant discussion. This would
be similar to how the Python language handles it:

https://www.python.org/dev/peps/pep-0001/

In short, it is both a process and resulting document -- at this point, CF
has a process, but not a document. I think the document is very helpful
because:

1) it can help clarity and focus the discussion
2) It preserves the results of the discussion for posterity.

The problem is that when we add something to CF, we document what that
something is, and how it is to be used, but we don't (and shouldn't)
document why it was decided to be done that way.

A CEP would contain:

- The background of why that feature is needed
- A summary of the solution
- A summary of the pros and cons of that solution
- A summary of why that particular solution was selected
- A summary of what other options were considered and rejected, and why.

I think having this an official part of the process would be great, but
even if now, we can still informally write such documents when discussing a
challenging issue.

The current discussion of calendars on gitHub is a graet example -- that
discussion would be really helped by a CEP document to refer to.

Thoughts?

-CHB







-- 
Christopher Barker, Ph.D.
Oceanographer
Emergency Response Division
NOAA/NOS/OR&R            (206) 526-6959   voice
7600 Sand Point Way NE   (206) 526-6329   fax
Seattle, WA  98115       (206) 526-6317   main reception
Chris.Barker at noaa.gov
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.cgd.ucar.edu/pipermail/cf-metadata/attachments/20181108/9bce5540/attachment.html>
Received on Thu Nov 08 2018 - 10:52:47 GMT

This archive was generated by hypermail 2.3.0 : Tue Sep 13 2022 - 23:02:43 BST

⇐ ⇒