speced / speced/respec

Using `github` while disabling `edDraftURI`

Open
#5,103 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
JavaScript
Stars
806
Forks
434
Avg merge
1d 21h
Merged PRs (30d)
32

Description

Description of problem

https://respec.org/docs/#edDraftURI

says:

Note: it is strongly recommended that you don't publish Editor's drafts, and instead auto-publish your specification using the W3C's Echidna workflow.

Yet, https://respec.org/docs/#github says :

This automatically generates: .[..] edDraftURI

Those 2 statements seem to contradict each other.

URL to affected spec or repo:

https://github.com/w3c/pointerevents/blob/level3/index.html

What happened (e.g., it crashed)?:

edDraftURI: '',
github: "w3c/pointerevents",

Unless edDraftURI is present, respec generates one by default (due to our use of github). Yet, we don't publish an ED for that level, even if we have a GitHub repo.

Expected behavior (e.g., it shouldn't crash):

Ability to use github for GitHub feedback, while disabling the presence edDraftURI.

As a side, while

edDraftURI: ''

does the trick for now, you can't pass an empty string as a URL parameter <url>?edDraftURI= (eg to use with w3c/spec-prod/W3C_BUILD_OVERRIDE).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the edDraftURI and github configuration documentation, then reproduce the issue with the pointerevents configuration and with an edDraftURI URL parameter. Done means GitHub feedback remains available while edDraftURI can be disabled, including through an empty URL parameter.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.