update @maplibre/maplibre-react-native github url#2385
update @maplibre/maplibre-react-native github url#2385KiwiKilian wants to merge 1 commit intoreact-native-community:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the githubUrl for @maplibre/maplibre-react-native to point to the repository root, aligning the Directory’s GitHub-based checks (e.g., README detection) with where the README actually lives.
Changes:
- Updated the
githubUrlfor@maplibre/maplibre-react-nativefrom a subdirectory path to the repo root URL.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@Simek hmmm – your validation wants us to point to the package directory... But we want the main README at the root, because that's were most traffic enters... Do you have good examples of other repositories handling this? |
|
Hey @KiwiKilian, The README is visible on the package page since we fetch it from the package bundle: The scoring logic checks GitHub repository and npm registry for REDME file existence, but there might be an issue with the logic in there, will look at this soon.
As a workaround, you can address this on your side by creating symlink in package directory to the README file at the repository root (via regular symlink or custom GitHub one). Example: |
|
Thanks for looking into this! I will check, if the symlink works. How fast is RN directory updated? But as the README content is displayed on RN directory, wouldn't it be possibel to add this as an alternative check for the existence of the README? Or the existence of the README in the file tree in the "code" section? |
Package READMEs are fetch client side, while libraries data exposed by API is fetch server side and refreshed on each deployment. I have checked the data for similar cases and there are 87 package with both README files set to Can you create an issue for that case in the repo, so we can track the progress in there, instead of this PR? |
|
Done, thanks for your investigations! |

📝 Why & how
It looks like the check, if a README.md is present is done from the GitHub URL. We have placed the README at the root and copy it into the package only during packaging. So we should probably stick with this root URL or the check should see if there is a README at the given GitHub URL or within the published package? Not sure. But for now I don't wont to give up score for this 😄.
✅ Checklist
react-native-libraries.jsonreact-native-libraries.json