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 disclaimer on the skill filter in the issue finder #518

Closed
1 task
dhruvkb opened this issue Sep 25, 2020 · 14 comments · Fixed by #540
Closed
1 task

Add disclaimer on the skill filter in the issue finder #518

dhruvkb opened this issue Sep 25, 2020 · 14 comments · Fixed by #540
Assignees
Labels
🕹 aspect: interface Concerns end-users' experience with the software 📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature good first issue New-contributor friendly help wanted Open to participation from the community 🟨 priority: medium Not blocking but should be fixed soon 🏁 status: ready for work Ready for work

Comments

@dhruvkb
Copy link
Member

dhruvkb commented Sep 25, 2020

Description

Not all issues have skills marked on them, especially if they are simple issues that do not require proficiency in any specific framework or language. Those issues are gone when filtering by skill in the Issue Finder. This behaviour should be explained to the user on the page.

Reproduction

  1. Open the Issue Finder.
  2. See all issues.
  3. Filter by a specific skill.
  4. See a much much smaller subset of issues, and more likely the harder ones.
  5. That's not good.

Expectation

This anomalous behaviour should be well documented.

Alternatives

Alternatively, we can collectively decide that every issue should have a skill, regardless of the level of proficiency of said skill required to resolve the issue (might tie into creativecommons/ccos-scripts#86).

Resolution

  • I would be interested in resolving this bug.
@dhruvkb dhruvkb added help wanted Open to participation from the community good first issue New-contributor friendly 🟨 priority: medium Not blocking but should be fixed soon 🏁 status: ready for work Ready for work ✨ goal: improvement Improvement to an existing feature 📄 aspect: text Concerns the textual material in the repository 🕹 aspect: interface Concerns end-users' experience with the software Hacktoberfest labels Sep 25, 2020
@CodeSarthak
Copy link

Hey @dhruvkb ,

I think switching to a system where we have to assign a skill to each issue might be a good choice in the long run but it will take time to switch over and it would have to be very well documented and prominent in the docs.

Therefore, I believe that a short term fix might be to simply document this behavior. Then, we can open up a new issue and work towards a more permanent/long-term fix.

How does that sound?

P.S. : This is my first issue here 😁

@dhruvkb
Copy link
Member Author

dhruvkb commented Sep 25, 2020

Yes, we should document this for now.

@CodeSarthak
Copy link

Great, should I go ahead and do that?

@c99SRS
Copy link
Contributor

c99SRS commented Oct 6, 2020

Hi @dhruvkb, can I work on this?

@dhruvkb
Copy link
Member Author

dhruvkb commented Oct 7, 2020

@c99SRS in #527, @CodeSarthak has already made a PR to fix this, but I've added some pointers for improvement to that. Could you open a PR with only the suggested changes (so that I can merge both independently)?

@c99SRS
Copy link
Contributor

c99SRS commented Oct 10, 2020

HI @dhruvkb , Could you please tell any specific UI for this or is there any particular section we have to make the change?
But I have made changes to this. Attached the screenshot also. Please let me know if it looks good.
IssueFinder

@dhruvkb
Copy link
Member Author

dhruvkb commented Oct 10, 2020

Screenshot 2020-10-10 at 1 42 21 PM

^ Can you put the disclaimer here instead of the header region?

@c99SRS
Copy link
Contributor

c99SRS commented Oct 10, 2020

@dhruvkb

Screenshot 2020-10-10 at 1 42 21 PM

^ Can you put the disclaimer here instead of the header region?

Don't you think it would be so much text on that particular section? I made changes also. Take a look and provide some feedback. If it looks odd, then I can suggest that text we can add in the header part 2-3 lines below from the current header part and we will mention that "Disclaimer" followed by those texts. Let me know your view on this?
issue_finder

@dhruvkb
Copy link
Member Author

dhruvkb commented Oct 10, 2020

How about we add an asterisk * to the Skill set header and put that text in small font at the bottom of the page?

@c99SRS
Copy link
Contributor

c99SRS commented Oct 10, 2020

How about we add an asterisk * to the Skill set header and put that text in small font at the bottom of the page?

Yes. we can try out that one.

@c99SRS
Copy link
Contributor

c99SRS commented Oct 10, 2020

HI @dhruvkb , please take a look, made some changes. Attached the screenshot.
Issue_Finder

@c99SRS
Copy link
Contributor

c99SRS commented Oct 10, 2020

Hey @dhruvkb , I am raising one PR, if you are ok with this.

c99SRS added a commit to c99SRS/creativecommons.github.io-source that referenced this issue Oct 10, 2020
@c99SRS
Copy link
Contributor

c99SRS commented Oct 12, 2020

Hi @dhruvkb , could you please merge my PR?

@dhruvkb
Copy link
Member Author

dhruvkb commented Oct 12, 2020

@c99SRS I'll review and merge it soon. You can continue to work on other issues in the meantime!

dhruvkb added a commit to c99SRS/creativecommons.github.io-source that referenced this issue Oct 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕹 aspect: interface Concerns end-users' experience with the software 📄 aspect: text Concerns the textual material in the repository ✨ goal: improvement Improvement to an existing feature good first issue New-contributor friendly help wanted Open to participation from the community 🟨 priority: medium Not blocking but should be fixed soon 🏁 status: ready for work Ready for work
Projects
None yet
3 participants