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

Add descriptions to projects in data/projects.json #53

Closed
bnb opened this issue Nov 22, 2018 · 7 comments
Closed

Add descriptions to projects in data/projects.json #53

bnb opened this issue Nov 22, 2018 · 7 comments
Labels
good first issue Good for newcomers
Milestone

Comments

@bnb
Copy link
Member

bnb commented Nov 22, 2018

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 👍

@bnb bnb added this to the 1.0.0 milestone Nov 22, 2018
@hemal7735
Copy link
Collaborator

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

@bnb
Copy link
Member Author

bnb commented Nov 23, 2018

@hemal7735 for this issue? I +1 that 👍

@bnb bnb added the good first issue Good for newcomers label Nov 23, 2018
@boneskull
Copy link
Contributor

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

@hemal7735
Copy link
Collaborator

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

@bnb
Copy link
Member Author

bnb commented Dec 6, 2018

@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
Copy link
Collaborator

hemal7735 commented Dec 6, 2018

@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 😉

@bnb bnb added good first issue Good for newcomers and removed good first issue Good for newcomers labels Dec 15, 2018
@good-first-pin good-first-pin bot pinned this issue Dec 15, 2018
@bnb bnb closed this as completed in fb9b684 Jul 23, 2019
@aashimawadhwa
Copy link

can you please explain the issue more elaborately

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

No branches or pull requests

4 participants