Skip to content

Where should the package git URL point to? #4

@dandv

Description

@dandv

package.js has a readme field that can point to an arbitrary Markdown file - great! We can point that to the Meteor-specific README for the package. That README is located in the meteor directory of the meteor-integration branch of our fork. (We shouldn't point to the original repo because we don't know if the author will merge).

The question is, where to point the git field of package.js? Where do we want users to land when they click "GitHub" (presumably to check the library's activity) and "Report Bugs"?

Users may not realize that the package is not primarily maintained by a Meteor dev.

The author's repo

Pros

  • user sees the real repo, with accurate star count
  • author gets notified
  • if author wasn't Meteor-friendly, users reporting issues there shows demand for Meteor

Cons

  • if the author wasn't fine with the integration, they might be antagonized / close the issues
  • Meteor-integration-specific issues may appear off-topic to the author; this can be mitigated by CC-ing one of the @MeteorPackaging/packagers (as the READMEs can in fact advise)

Our MeteorPackaging fork repo

Pros

  • we'll be notified when users create issues

Cons

  • user sees a repo with zero stars
  • we're artificially notified if users report library-specific (not integration-specific) issues
  • the author doesn't get notified; we'd have to proxy the issues

Workarounds

  • Have a README in our repo (where the "GitHub" link will land) that clearly states, "This is the Meteor packaging for XXX, head over there for anything but Meteor-specific issues", and don't PR this readme

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions