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

Link to bug tracker and repository in package.json #364

Closed
doug-wade opened this issue Aug 3, 2023 · 5 comments
Closed

Link to bug tracker and repository in package.json #364

doug-wade opened this issue Aug 3, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@doug-wade
Copy link
Owner

Socket.dev is lowering our score because our package.json is missing some of the links they expect: the website, the issue tracker, and the repository. Let's go through all our package.jsons and add the required fields.

@doug-wade doug-wade added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 3, 2023
@doug-wade
Copy link
Owner Author

I marked this a good first issue, so to make it a little easier, here's the docs: https://docs.npmjs.com/cli/v9/configuring-npm/package-json

And I think we need to add the following three keys to every file called package.json in the monorepo:

{
    "bugs": { "url" : "https://github.com/doug-wade/tybalt/issues" },
    "homepage": "https://tybalt.org",
    "repository": {
        "type": "git",
        "url": "https://github.com/doug-wade/tybalt.git"
     }
}

@Ashvith10
Copy link
Contributor

@doug-wade about the repository, should the repository link for packages in workspace point to the main git repo, or the link to the topmost file? (https://github.com/doug-wade/tybalt.git vs https://github.com/doug-wade/tybalt/tree/master/packages/cli)?

@doug-wade
Copy link
Owner Author

My understanding is that we should like to the main git repo in the url (iiuc, the url is to a git repository, so something that can be cloned, and the packages subdirectories can't be cloned) and we should specify the directory in directory

@Ashvith10
Copy link
Contributor

There are a few missing pages and labels.

Missing labels are:

  • eleventy-plugin-vanilla-example
  • esbuild-plugin
  • test-utils-lit-example

Missing documentations are:

  • eleventy-plugin-vanilla-example
  • example
  • test-utils-lit-example
  • website

What should be done with these?

@doug-wade
Copy link
Owner Author

I think what would make the most sense would be:

  • eleventy-plugin-vanilla-example -> eleventy plugin docs + tracker
  • example -> root docs + tracker
  • test-utils-lit-example -> test-utils docs + tracker
  • website -> website issue tracker + tybalt.org root page

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants