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

Adding issue triage to how-to #541

Merged
merged 23 commits into from
Mar 9, 2022
Merged

Adding issue triage to how-to #541

merged 23 commits into from
Mar 9, 2022

Conversation

CathPag
Copy link
Collaborator

@CathPag CathPag commented Mar 5, 2022

No description provided.

@netlify
Copy link

netlify bot commented Mar 5, 2022

✔️ Deploy Preview for cncfglossary ready!

🔨 Explore the source changes: 0e3abb5

🔍 Inspect the deploy log: https://app.netlify.com/sites/cncfglossary/deploys/6228664545d0e400078a17d7

😎 Browse the preview: https://deploy-preview-541--cncfglossary.netlify.app/contribute

@CathPag CathPag added the documentation Improvements or additions to documentation label Mar 5, 2022
Copy link
Collaborator

@jihoon-seo jihoon-seo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CathPag Thank you for your devotion!

I left some comment.
PTAL! 😊

content/en/contribute/_index.md Outdated Show resolved Hide resolved
content/en/contribute/_index.md Outdated Show resolved Hide resolved
content/en/contribute/_index.md Outdated Show resolved Hide resolved
content/en/contribute/_index.md Outdated Show resolved Hide resolved
content/en/contribute/_index.md Outdated Show resolved Hide resolved
content/en/contribute/_index.md Outdated Show resolved Hide resolved
CathPag and others added 8 commits March 6, 2022 09:00
Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>
Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>
Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>
Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>
Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>
Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>
@CathPag
Copy link
Collaborator Author

CathPag commented Mar 6, 2022

Thanks for your great suggestions @jihoon-seo :)
I uploaded the images here but they don't appear. Can you help?

@CathPag
Copy link
Collaborator Author

CathPag commented Mar 6, 2022

Never mind. I saw your comment in the other issue that it was the file name :) If this looks good to go, can you approve please?

Copy link
Collaborator

@seokho-son seokho-son left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@CathPag the changes sound good to me in general :)

I have an opinion regarding issue template (the template we are using in the guide)

I think we'd better to use the other issue template for proposing a new term.

The current examples (screenshots) are using English Language Glossary Request template which dose not includes informative contents. (https://github.com/cncf/glossary/issues/new?assignees=&labels=english&template=en.yml&title=%5BEnglish%5D%3A+GlossaryWordHere)

The latest template includes some guidelines to make applicants provides some contexts for a suggested term. Request to add a new term (Default:English)

https://github.com/cncf/glossary/issues/new?assignees=&labels=lang%2Fen%2Cnew+term&template=new-term.yml&title=%5BNew+term%5D+%60GlossaryTermHere%60+for+%60En%60

Also, the template assigns predefined labels automatically. (currently, lang/en and new term)
Maybe we can update the template with more appropriate labels (such as awaiting-triage)

My suggestion regarding issue templates as follows.

  • removing English Language Glossary Request template
  • guiding contributors use Request to add a new term (Default:English) template
    • updating default labels for Request to add a new term (Default:English)

If we agree with the suggestion, I will open a PR to update issue templates.

content/en/contribute/_index.md Outdated Show resolved Hide resolved
content/en/contribute/_index.md Outdated Show resolved Hide resolved
@iamNoah1
Copy link
Collaborator

iamNoah1 commented Mar 7, 2022

@CathPag the changes sound good to me in general :)

I have an opinion regarding issue template (the template we are using in the guide)

I think we'd better to use the other issue template for proposing a new term.

The current examples (screenshots) are using English Language Glossary Request template which dose not includes informative contents. (https://github.com/cncf/glossary/issues/new?assignees=&labels=english&template=en.yml&title=%5BEnglish%5D%3A+GlossaryWordHere)

The latest template includes some guidelines to make applicants provides some contexts for a suggested term. Request to add a new term (Default:English)

https://github.com/cncf/glossary/issues/new?assignees=&labels=lang%2Fen%2Cnew+term&template=new-term.yml&title=%5BNew+term%5D+%60GlossaryTermHere%60+for+%60En%60

Also, the template assigns predefined labels automatically. (currently, lang/en and new term) Maybe we can update the template with more appropriate labels (such as awaiting-triage)

My suggestion regarding issue templates as follows.

  • removing English Language Glossary Request template

  • guiding contributors use Request to add a new term (Default:English) template

    • updating default labels for Request to add a new term (Default:English)

If we agree with the suggestion, I will open a PR to update issue templates.

agreed :)

CathPag and others added 4 commits March 7, 2022 09:11
Co-authored-by: Seokho Son <shsongist@gmail.com>
Co-authored-by: Seokho Son <shsongist@gmail.com>
Copy link
Collaborator

@iamNoah1 iamNoah1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome @CathPag :) lgtm

Copy link
Collaborator

@seokho-son seokho-son left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM :)

@seokho-son seokho-son merged commit a1075ee into main Mar 9, 2022
@jihoon-seo jihoon-seo deleted the issue-triage branch March 10, 2022 00:07
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants