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

chore(packages): add repository directory to package #237

Merged
merged 1 commit into from
Apr 4, 2024

Conversation

smackfu
Copy link
Member

@smackfu smackfu commented Mar 28, 2024

Description

Set the repository fields properly for the packages, including directory names.

Motivation and Context

I noticed the header image here is a 404: https://www.npmjs.com/package/parrot-friendly

This is because npmjs.com is taking the relative URL for the image specified in the README.md and applying it to the root GitHub repo, which is not where that file exists since it's a monorepo.

I suspect that adding the directory here will fix the issue. At the very least it is more correct.

How Has This Been Tested?

Not tested. package.json config only.

Verified that other popular monorepos have this same configuration:
https://github.com/babel/babel/blob/main/packages/babel-compat-data/package.json
https://github.com/jestjs/jest/blob/main/packages/create-jest/package.json

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (adding or updating documentation)
  • Dependency update

Checklist:

  • My change requires a change to the documentation and I have updated the documentation accordingly.
  • My changes are in sync with the code style of this project.
  • There aren't any other open Pull Requests for the same issue/update.
  • These changes should be applied to a maintenance branch.
  • This change requires cross browser checks.
  • This change impacts caching for client browsers.
  • I have added the Apache 2.0 license header to any new files created.

What is the Impact to Developers Using parrot?

Hopefully better display on npmjs.com.

@smackfu smackfu requested a review from a team as a code owner March 28, 2024 19:29
@smackfu smackfu requested review from a team and removed request for a team April 1, 2024 13:04
@bishnubista bishnubista merged commit 00c989e into main Apr 4, 2024
4 checks passed
@bishnubista bishnubista deleted the add-repository-directories branch April 4, 2024 14: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.

3 participants