Using Github Issues for MNX

Hi all,

We're now ready to start using Github issues for further discussion of MNX,
in its associated repository:
    https://github.com/w3c/mnx

All one needs to use Github is an account, which can be obtained for free.

In most W3C groups, issue-focused discussions actually form the backbone of
group communication, rather than email threads. So we'd like to make that
shift here, now. This will help us in a number of ways:

- Github can naturally guide us to separate our concerns into distinct,
clearly identified issues
- Members can quickly identify whether an issue has been raised already
- Members can view the prior discussion of an issue before entering it
- The tracking of issues allows us to determine their disposition and
survey the status of projects
- The records of each issue's discussion serve as a valuable audit trail as
we decide how to progress the spec

We will also start to use Github pull requests for all proposed concrete
changes to MNX documents. Pull requests are the way that one packages
changes that one would like to see applied to the repository; see  Only the
chairs are able to approve and merge pull requests, for now.

There are a number of "labels" that are available for tagging issues. Feel
free to use these, but the chairs will generally follow up and apply them
as needed.

There are also "milestones" that permit issues to be designated as slated
for completion in different timeframes. We're not using these yet, in this
early stage, so we'll explain that later when we make more use of them.

The chairs have a few requests that should make the use of issues as
productive as possible for all of us:

- Please search the issues to see if your concern has already been raised,
before creating a new one.
- Please isolate your concerns in separate issues. "Run-on" issues that
combine unrelated concerns will be immediately closed by the chair and we
will ask you to break them out into multiple issues.
- Please try to provide relevant examples that illustrate the goal to be
achieved by your change, or that show the gap that you are pointing out. If
something is to be changed, support your reasoning in a way that others can
understand.
- Please use group email threads only for general discussions of process,
or for topics that are resistant to packaging as an issue for some reason.

Thanks, and I look forward to the next phase of work on MNX!

Best,

.            .       .    .  . ...Joe

Joe Berkovitz
Founder
Noteflight LLC

49R Day Street
Somerville MA 02144
USA

"Bring music to life"
www.noteflight.com

Received on Wednesday, 26 April 2017 20:14:10 UTC