Skip to content

docs: link the live demo, and say how to pick up an issue - #19

Merged
sandeeps85 merged 1 commit into
mainfrom
docs/demo-link-and-claiming
Oct 15, 2026
Merged

sandeeps85 merged 1 commit into
mainfrom
docs/demo-link-and-claiming

Conversation

@sandeeps85

Copy link
Copy Markdown
Contributor

What and why

  • README: opens with Try it in your browser →, linking the live Space
    (https://huggingface.co/spaces/m87techlabs/abc-folk), and points would-be contributors to the
    good first issue label.

  • CONTRIBUTING: "Picking up an issue." Two PRs arrived for slm runs list --json for scripts #13 within hours, one from someone who had
    asked first and was still waiting for an answer. The new section asks contributors to:

    • comment with a plan, wait to be assigned, then open the PR;
    • run make lint and make test (including the abc2midi note);
    • disclose AI assistance.

    It also commits maintainers to answering within a few days. The PR template asks for Closes #N and
    the assignment.

  • CONTRIBUTING command list: adds slm runs list --json (feat(cli): add --json to slm runs list #17). Merge feat(cli): add --json to slm runs list #17 first.

  • Runbook hf-hub.md H.5: checks against the live Space, with real output:

    • Space metadata, the page's info file, and the SHA-256 of the served weights, which matches the
      export;
    • two notes on what the Hub does to a static Space (the redirect for large files, the injected
      script line).
  • ROADMAP: the "Hugging Face Hub" section is done. CHANGELOG, runbooks index.

Checklist (CONTRIBUTING.md)

  • make lint and make test (247 passed) pass locally
  • Docs only; runbook output captured by running each command
  • Conventional commit; no trailers

Two pull requests arrived for #13 within hours, one from someone who had asked on the issue and
was still waiting for an answer. CONTRIBUTING now asks contributors to comment, wait to be
assigned, and only then open a pull request, and commits maintainers to answering within days;
the PR template asks for the linked issue and the assignment. It also says AI assistance is fine
when disclosed and understood, matching how the contributions so far were made.

The README opens with the live Space, now that it is verified: the runbook's H.5 gains checks
against it with real output, and the Hugging Face ROADMAP section is done.
@sandeeps85
sandeeps85 merged commit ac07b28 into main Oct 15, 2026
6 checks passed
@sandeeps85
sandeeps85 deleted the docs/demo-link-and-claiming branch October 15, 2026 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant