android / android/nowinandroid
[Documentation]: PR template link is broken?
- Dominant language
- Kotlin
- Stars
- 21.8k
- Forks
- 4.6k
- Avg merge
- 19h 20m
- Merged PRs (30d)
- 2
Description
### Is there an existing issue for this?
- [x] I have searched the existing issues
### Page URL (type "NEW" for a new page suggestion)
https://github.com/android/nowinandroid/blob/main/.github/pull_request_template.md
### What's the documentation problem or suggestion?
The link in the PR template may be broken.
https://github.com/android/nowinandroid/blob/1d2029aa2c4273ff75a9239112f32800800bd26b/.github/pull_request_template.md?plain=1#L15
Regarding the link in the code above, this link works fine when clicked on `.github/pull_request_template.md`.
But when clicked on an actual PR, it takes you to [this page](https://github.com/tools/setup.sh#L40) (try it on [this PR](https://github.com/android/nowinandroid/pull/1183), for example)
Perhaps this link should be described as an absolute link rather than a relative link (I'm not sure).
Also, there is one more point that needs to be corrected.
The link above refers to line 40 of `tools/setup.sh`.
https://github.com/android/nowinandroid/blob/1d2029aa2c4273ff75a9239112f32800800bd26b/tools/setup.sh#L40
I think this is line 36 exactly and should be corrected.
https://github.com/android/nowinandroid/blob/1d2029aa2c4273ff75a9239112f32800800bd26b/tools/setup.sh#L36
### Code of Conduct
- [X] I agree to follow this project's Code of Conduct
Contributor guide
Research direction
Inspect .github/pull_request_template.md and tools/setup.sh, then verify the links from PR #1183 and the referenced line numbers. Correct the broken link and line reference, and confirm both links resolve to the intended locations.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100