fix: file-a-bug → new issue form; update README doc links#5138
Open
marcoscaceres wants to merge 2 commits intomainfrom
Open
fix: file-a-bug → new issue form; update README doc links#5138marcoscaceres wants to merge 2 commits intomainfrom
marcoscaceres wants to merge 2 commits intomainfrom
Conversation
marcoscaceres
force-pushed
the
fix/file-a-bug-link
branch
5 times, most recently
from
71957a9 to
95d7009
Compare
- github.js: 'File an issue' now links to /issues/new/choose (new issue form) instead of /issues (list). The list was making spec editors hunt for a way to file a new bug. newIssuesURL was already computed but unused for this link. Fixes #3457 (High priority since 2021). - README.md: documentation links now point to respec.org/docs instead of the raw wiki URLs; wiki is the source but respec.org/docs is the rendered single-page version that's much easier to read. - README.md: specref.org link upgraded from http:// to https://
marcoscaceres
force-pushed
the
fix/file-a-bug-link
branch
from
95d7009 to
41db23f
Compare
There was a problem hiding this comment.
Pull request overview
Updates GitHub-related UX and documentation links so users land on the correct GitHub “new issue” flow and on the rendered ReSpec docs site rather than the raw wiki.
Changes:
- Point “File a bug” header link to GitHub’s
/issues/new/chooseinstead of the issues list. - Update core GitHub module tests to assert the new “File a bug” URL.
- Refresh README documentation URLs to
https://respec.org/docs/and upgrade specref to HTTPS.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
src/core/github.js |
Adjusts the “File a bug” participate link target to GitHub’s new-issue chooser URL. |
tests/spec/core/github-spec.js |
Updates expectations so tests validate the new issue-form URL. |
README.md |
Switches key docs links to respec.org/docs and upgrades specref to HTTPS. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
Not keeping link to all issues and just adding file new issue link? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
src/core/github.js— Fix #3457 (High priority since 2021)The "File an issue" link in spec headers was pointing to
/issues(the list) instead of/issues/new/choose(the new issue form).newIssuesURLwas already computed at line 215 but not used for this link. Also extracted the URL construction to a shared variable to avoid duplication.README.mdrespec.org/docsinstead of raw wiki URLsspecref.orglink upgraded to HTTPS