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

Create EDITOR_ISSUE_TEMPLATE.md #1179

Merged
merged 7 commits into from May 28, 2020
Merged

Conversation

Ismael-KG
Copy link
Collaborator

@Ismael-KG Ismael-KG commented May 28, 2020

Summary

This is the first draft of an issue template I want to propose for editors to use when they review/edit a chapter in The Turing Way.

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

  • Wondering if this could be an interesting starting point for a template for suggesting editorial changes?
  • It is based on the general template

What should a reviewer concentrate their feedback on?

  • In the "What needs to be done" section, are there any further points an editor may generally consider?
  • For example, could this template be used to suggest fixes to typos?
  • For the user of this template, might it be confusing to have the html comment tags in each bullet point?

@welcome
Copy link

welcome bot commented May 28, 2020

Thank You Banner
💖 Thanks for opening this pull request! 💖 The Turing Way community really appreciates your time and effort to contribute to the project. Please make sure you have read our Contributing Guidelines and filled in our pull request template to the best of your ability.
If you are submitting a new chapter, here are some things that will help get your pull request across the finish line! 🏁

  • Check you have removed all lorem ipsums from the chapter template (if you used it)
  • Check for any abbreviations or latin phrases (such as "e.g." or "i.e.") in your writing. See our style guide for more information on this topic.
  • Make sure you have added your new chapter to the Table of Contents

    We have Continuous Integration tests that check the writing style and will help you track down any slip-ups ♻️ The Netlify bot will also comment with a preview of the book with your additions so you can see how it will look once it's merged! 🎉

    We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can. If we don't acknowledge this pull request after 7 days, feel free to chat to us about it in our gitter channel.

@netlify
Copy link

netlify bot commented May 28, 2020

Deploy preview for the-turing-way ready!

Built with commit 6885ba5

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

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.

Thank you @Ismael-KG. This is great. I have added some suggestions but do feel free to edit as per your thought on editors understanding.

.github/ISSUE_TEMPLATE/EDITOR_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/EDITOR_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/EDITOR_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
Ismael-KG and others added 3 commits May 28, 2020 15:30
Co-authored-by: Malvika Sharan <malvikasharan@gmail.com>
Co-authored-by: Malvika Sharan <malvikasharan@gmail.com>
Co-authored-by: Malvika Sharan <malvikasharan@gmail.com>
@malvikasharan
Copy link
Collaborator

Thanks @Ismael-KG! I will let @sgibson91 have a look before we merge this.

Copy link
Member

@sgibson91 sgibson91 left a comment

Choose a reason for hiding this comment

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

Hey @Ismael-KG, this looks great THANK YOU! I've left two small suggestions, you don't need to keep them if you don't like them 😊

.github/ISSUE_TEMPLATE/EDITOR_ISSUE_TEMPLATE.md Outdated Show resolved Hide resolved
Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>
Co-authored-by: Sarah Gibson <44771837+sgibson91@users.noreply.github.com>
@malvikasharan
Copy link
Collaborator

Great work @Ismael-KG and thank you @sgibson91 for the review. 💃

@malvikasharan malvikasharan merged commit 2086fba into the-turing-way:master May 28, 2020
@welcome
Copy link

welcome bot commented May 28, 2020

Congratulations Banner
Congrats on merging your first pull request! 🎉 We here at The Turing Way are proud of you! 💖 Thank you so much for your contribution 🎁

@malvikasharan
Copy link
Collaborator

@all-contributors please add @Ismael-KG for content.

@allcontributors
Copy link
Contributor

@malvikasharan

I've put up a pull request to add @Ismael-KG! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants