[Om] Call for Discussion: CD editing process (technical)

Michael Kohlhase michael.kohlhase at fau.de
Sun Apr 29 10:34:39 CEST 2018

Dear all,

as you know, we have been reorganizing the OpenMath resources and web
site as multiple repositories at [1]

In particular we have the new CDs repository [2], which has the CD
resources and feeds the CD web site [3]

The idea is that [2] should facilitate CD development by providing
public source access, issues, pull requests, and notifications. Now, the
first outside user (Jacob Beal) has taken advantage of this first by
raising an issue [4], and then providing a pull request [5] which is
currently being discussed. In a nutshell the proposal is to add negated
binary connectives nor, nand, and nxor to logic1.ocd.

So far so good, but this raises the question of how the CD approval
process should be organized (technically).

The OpenMath Standard [6] only says

      > 4.5 Content Dictionaries Reviewing Process

> The /OpenMath/ Society is responsible for implementing a review and
> process to assess the accuracy of the mathematical content of Content
> The status (see |CDStatus|) and/or the version number (see |CDVersion|
) of a Content |
> Dictionary may change as a result of this review process.

which leaves the process open and the OpenMath Society delegates the
responsibility to its CD Editor (James Davenport).

James and I have started discussing the technical process of approving
CD revisions. We propose that we make the GitHub-supported process we
have started with Jacob's proposal the standard and document it in the
README of  [2].

Here is what we think the process should be.

 1. An extension proposal is made via a GitHub issue at [2] and
    discussed there.
 2. The discussion is concretized into a pull request (PR) to [2] that
    is discussed further on the PR (including inline comments) until all
    issues are resolved.
 3. James explicitly approves the PR and someone with push rights merges
 4. the changes are announced and added to a changelog.

We would like your input on this proposal (in particular what we should
do for 4.)

James & Michael

[1] https://github.com/OpenMath

[2] https://github.com/OpenMath/CDs

[3] http://openmath.org/cd/

[4] https://github.com/OpenMath/CDs/issues/32

[5] https://github.com/OpenMath/CDs/pull/34

[6] http://www.openmath.org/standard/om20-2017-07-22/omstd20.html#cdapprove


Prof. Dr. Michael Kohlhase,  http://kwarc.info/kohlhase, skype: mibein42

Professur für Wissensrepräsentation & -verarbeitung
  Informatik, FAU Erlangen Nürnberg, Martensstr. 3, D-91058 Erlangen, Room 11.139,
  tel/fax: (49) 9131-85-64052/55, michael.kohlhase at fau.de 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mailman.openmath.org/pipermail/om/attachments/20180429/a3d2280d/attachment.html>

More information about the Om mailing list