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

[Ready for Review] Updating Issue Templates #1058

Merged
merged 7 commits into from Apr 28, 2020
Merged

Conversation

sgibson91
Copy link
Member

@sgibson91 sgibson91 commented Apr 28, 2020

Summary

This PR is updating the issue templates for the repository.

List of changes proposed in this PR (pull-request)

  • Added a config.yml file which will include links to the collaboration cafe documentation and gitter chat, alongside the new chapter and general issue templates
  • Added a bug report template so it's clearer how people should report unexpected behaviour
  • Updated (emojified) the general and new chapter templates

What should a reviewer concentrate their feedback on?

  • Does anyone know how to test the emojis will render correctly or how to convert from U+xxx to \Uxxxxxxxx? @GeorgianaElena?
  • Everything looks ok?

Acknowledging contributors

The config.yml file will add two new options to the "choose issue template" page: a link to the Collaboration Cafe documentation, and a link to the Gitter channel for chatting.
@netlify
Copy link

netlify bot commented Apr 28, 2020

Deploy preview for the-turing-way ready!

Built with commit 85bff40

https://deploy-preview-1058--the-turing-way.netlify.app

@sgibson91 sgibson91 changed the title [WIP] Updating Issue Templates [Ready for Review] Updating Issue Templates Apr 28, 2020
@sgibson91 sgibson91 added the review request Label a PR for urgent request for review, for example to approve a report, abstract, newsletter etc. label Apr 28, 2020
@GeorgianaElena
Copy link
Contributor

@sgibson91 , I forked this repo and changed the default branch to be update-issue-templates and this is what it looks like when trying to open an issue:
turing-issue-templates

Live demo: https://github.com/GeorgianaElena/the-turing-way/issues/new/choose

@GeorgianaElena
Copy link
Contributor

GeorgianaElena commented Apr 28, 2020

This page https://www.fileformat.info/info/unicode/char/1f4d6/index.htm shows different encodings for the open book unicode (U+1F4D6). Down the page there's a "Python source code" encoding of it ("\U0001F4D6" for the open book emoji).

I think if you use that it will render the emoji.

Update: It works 🎉
turing-new

Copy link
Contributor

@GeorgianaElena GeorgianaElena left a comment

Choose a reason for hiding this comment

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

This looks excellent 🎉
I just added some suggestions with the "Python source code" version of the unicode emojis to have them render properly.

.github/ISSUE_TEMPLATE/CHAPTER_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/config.yml Outdated Show resolved Hide resolved
Thank you so much @GeorgianaElena! ✨ 🎨

Co-Authored-By: Georgiana Elena <GeorgianaElena@users.noreply.github.com>
@malvikasharan
Copy link
Collaborator

@all-contributors please add @GeorgianaElena for review. 🎉

@allcontributors
Copy link
Contributor

@malvikasharan

I've put up a pull request to add @GeorgianaElena! 🎉

Copy link
Collaborator

@malvikasharan malvikasharan left a comment

Choose a reason for hiding this comment

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

This looks great @sgibson91. I have included bullet point options like the previous template for consistency. Thank you so much for bringing this in <3

Can you please check if we need to keep the template folder that is outside .github folder: https://github.com/alan-turing-institute/the-turing-way/tree/update-issue-templates/templates

@sgibson91
Copy link
Member Author

sgibson91 commented Apr 28, 2020

Thank you for the review @malvikasharan! 💖

Yes we do need it, that template is for creating content not opening issues. Though it should probably be moved to book/templates/ to join the case study/notebook template.

@sgibson91 sgibson91 merged commit ca80260 into master Apr 28, 2020
@sgibson91 sgibson91 deleted the update-issue-templates branch April 28, 2020 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: merged review request Label a PR for urgent request for review, for example to approve a report, abstract, newsletter etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants