cutenode/good-first-issue

Add descriptions to projects in data/projects.json

bnb opened this issue · 7 comments

bnb commented

We currently support including descriptions in projects.json and consuming them (at least in the CLI – not entirely sure about the module), but don't currently have any descriptions.

Before we get a tremendous amount of projects, it would be incredible to get descriptions and require them when adding new ones so we don't have to do a bunch retroactively 👍

hemal7735 commented

Maybe good-first-issue or help-wanted? 🤔

bnb commented

@hemal7735 for this issue? I +1 that 👍

boneskull commented

could you not pull descriptions from description prop of octokit.repos.get()?

  • 👍1
hemal7735 commented

@boneskull that is great, would you like to contribute?
@bnb Are we planning to show description in the console?

bnb commented

@hemal7735 it's currently displayed in the project selector when you run good-first-issue without a project argument. We should also augment the lib/log.js output to surface the descriptions.

hemal7735 commented

@bnb we should not make an API call to display in the console for project-selector due to latency issues. Storing in projects.json seems valid, as it does not change often.

  • augmenting in lib/log.js would be helpful only in case of feeling-lucky, as in other projects folks would be aware of what project is about. There is no downside for all projects though 😉
aashimawadhwa commented

can you please explain the issue more elaborately