Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace bare links in index.ts files in the modules/versioning/*/ pattern with good links #30312

Open
3 tasks
Tracked by #29148
HonkingGoose opened this issue Jul 22, 2024 · 4 comments · May be fixed by #31222
Open
3 tasks
Tracked by #29148

Replace bare links in index.ts files in the modules/versioning/*/ pattern with good links #30312

HonkingGoose opened this issue Jul 22, 2024 · 4 comments · May be fixed by #31222
Assignees
Labels
good first issue Suitable for new contributors help wanted Help is needed or welcomed on this issue priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:refactor Refactoring or improving of existing code

Comments

@HonkingGoose
Copy link
Collaborator

Describe the proposed change(s).

Replace bare links in index.ts files in the modules/versioning/*/ pattern with good links.

Bare links are hard to read, and especially bad for screen reader users. Add a descriptive name to each bare link.

Todos

  • Write failing test first
  • Update all urls constants
  • Open PR

Write failing test first

Scope of test: all urls constants in the pattern modules/versioning/*/index.ts.

Condition Test result
Any item in the urls array is not wrapped between []() characters. Fail
All items in the urls array are wrapped between []() characters. Pass

Update all urls constants

Example of a good link, that passes the test:

 export const urls = [ 
   '[Microsoft API versioning guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#api-versioning)', 
 ]; 

Open PR

You are ready to open a pull request when the test passes.

Related discussion/issue

I asked about fixing the bare links in this discussion:

Fixing the bare links is part of the work for:

@HonkingGoose HonkingGoose added priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:refactor Refactoring or improving of existing code labels Jul 22, 2024
@HonkingGoose HonkingGoose added help wanted Help is needed or welcomed on this issue good first issue Suitable for new contributors labels Aug 26, 2024
Prtik12 added a commit to Prtik12/renovate that referenced this issue Sep 2, 2024
@2004yash
Copy link

I want to take up this task, can you assign this issue to me ?

@HonkingGoose
Copy link
Collaborator Author

We already have this PR, which would close the issue:

Do we want to:

  • Close the PR from above, and let @2004yash try again with a new PR?
  • Keep the PR from above, and let the maintainers help to finish the PR?
  • Do something else?

@2004yash
Copy link

@HonkingGoose So, should I work on this issue or not ??

@HonkingGoose
Copy link
Collaborator Author

@2004yash I don't know yet. I recommend that you wait to see what the maintainers think. 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Suitable for new contributors help wanted Help is needed or welcomed on this issue priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:refactor Refactoring or improving of existing code
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants