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

useful-resource label #88

Open
iteles opened this issue Sep 28, 2019 · 7 comments
Open

useful-resource label #88

iteles opened this issue Sep 28, 2019 · 7 comments
Labels
discuss Share your constructive thoughts on how to make progress with this issue

Comments

@iteles
Copy link
Member

iteles commented Sep 28, 2019

In fair few of our repos, people reading through the READMEs will often see something like this:
image

A large number of open issues.

This can give the impression that the repo is unmaintained or that there are many problems yet to be fixed with the material, but in reality, we use issues a little differently to most people.

Whereas some of the issues are genuine open questions or bugs, the vast majority are either suggestions for things that could be added to the readme or good articles/videos related to the repo.

For example in the learn-elixir repo, looking at the first 11 issues (most recent), there are 7 articles/videos that are interesting for people learning elixir, one question on the material and 3 suggested additions to the README.

image

It's not exactly 74 bugs!

I propose we create a label (in some form of green) to indicate that something is available for reading and a possible addition to the README, making it clear it's not a bug or misinformation.

The best I could come up with was a Good resourcelabel but I'd welcome any more descriptive label names! Defined as 'Denotes an article or video that's a good resource on this topic but is tangential or more advanced than the README'

@iteles iteles added the discuss Share your constructive thoughts on how to make progress with this issue label Sep 28, 2019
@nelsonic
Copy link
Member

nelsonic commented Aug 1, 2020

@iteles indeed many of the open issues across dwyl repos are "Relevant Links" left open for anyone else to add the link to the "Further Resources" section of the README.md: dwyl/learn-elixir#further-resources

@iteles
Copy link
Member Author

iteles commented Aug 1, 2020

Maybe a ‘Further Resources’ label with this as the explanation would be useful.

Would you say that normally the vast majority of these are pre-vetted? So reveiewers know that if it’s there as an issue it’s a ‘Green light’ for adding to the readme?
I would be tempted, as a reviewer, to request at least one line in the PR or in the issue on why this is a useful addition to the readme.

@nelsonic
Copy link
Member

nelsonic commented Aug 1, 2020

@iteles I think we should standardise the "Links" section of all our Repos as
"References and Recommended Relevant Resources" which is a catch-all for all types of links 🔗
without resorting to using the term "Awesome" ... 🙄

My issue with the good-resource is that applying the label makes a value judgement about the link.
And in an alphabetical list it appears before more important labels such as priority.
So every time someone wants to apply a priority label, they are forced to scroll past another label that will be irrelevant to them 95% of the time.

@nelsonic
Copy link
Member

nelsonic commented Aug 1, 2020

@iteles how about relevant-resource - "A link to a recent tutorial, blog post, video or other relevant resource that others will find useful - please include a title and brief description"

This will appear lower on the list of labels than priority which are our most frequently used labels.

https://github.com/dwyl/labels/issues/labels
image

If we go with useful-resource, it will appear after the T.. (time estimate) labels which are our second most popular set of labels:
image

Preference? 💭

@nelsonic
Copy link
Member

nelsonic commented Oct 6, 2021

Still totally think it's worth having this label. And still have a preference for useful-resource. 💭

@nelsonic nelsonic changed the title 'Good resource' label? useful-resource label Oct 6, 2021
@iteles
Copy link
Member Author

iteles commented Oct 6, 2021

Totally agree. Let's do it

@nelsonic
Copy link
Member

nelsonic commented Oct 6, 2021

@iteles great! 🎉
Any preference for the color of the label? 🌈
https://github.com/dwyl/labels/labels?page=2&sort=name-asc
image

Aware that we have a lot of Green: #52 and Blue for the priority labels ...
I usually just turn to https://flatuicolors.com/ when I need a color ...
image

Not trying to make this difficult. Just don't want to create "more problems" by adding more blue labels ... 💭

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Share your constructive thoughts on how to make progress with this issue
Projects
None yet
Development

No branches or pull requests

2 participants