[pull] main from the-turing-way:main

.github/ISSUE_TEMPLATE/01_bug_report.yml

@@ -0,0 +1,52 @@
+name: "\U0001F41B Bug report"
+description: Create a report to help us repair something that is currently broken
+title: "[BUG]:"
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Use this template to raise issues about viewing or building _The Turing Way_.
+        If you would like to raise an issue about fixing typos, or formatting issues in chapters, please use the [Editor's Issue template](https://github.com/alan-turing-institute/the-turing-way/issues/new?assignees=&labels=&template=EDITOR_ISSUE_TEMPLATE.yml).
+  - type: textarea
+    attributes:
+      label: Description
+      description: Use this section to clearly and concisely describe the bug.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected behavior
+      description: Tell us what you thought would happen.
+  - type: textarea
+    attributes:
+      label: Actual behaviour
+      description: Tell us what actually happens.
+  - type: textarea
+    attributes:
+      label: How to reproduce
+      description: Use this section to describe the steps that a user would take to experience this bug.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error -->
+  - type: textarea
+    attributes:
+      label: Your personal set up
+      description: Tell us a little about the system you're using or tested this bug in.
+      value: |
+        - **Operating System**:
+        - **Browser**:
+  - type: textarea
+    attributes:
+      label: Dependencies
+      description:
+        If you have found a bug when building the book, please give a list of the dependencies you are using.
+        You can generate a list of this using `pip freeze`.
+  - type: textarea
+    attributes:
+      label: Log messages
+      description:
+        Please include any relevant log or error messages here.
+        You may also include screenshots.

.github/ISSUE_TEMPLATE/02_edit_a_chapter.yml

@@ -0,0 +1,52 @@
+name: "\U0001F50D Edit a chapter"
+description: An existing chapter needs to be updated
+title: "[TO EDIT]: chapter/subchapter"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This template will guide you through the steps necessary for you to propose a chapter/subchapter to edit, review or restructure.
+        Please fill in the title above but do not remove the text "[TO EDIT]".
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: |
+        Please provide a detailed description of the chapter/subchapter you propose to edit, review or restructure.
+        Please provide as much context as possible and link to related issues and/or pull requests.
+        Providing links to sections you're referencing for clarity is highly encouraged.
+    validations:
+      required: true
+  - type: textarea
+    id: todo
+    attributes:
+      label: What needs to be done?
+      description: |
+        Please comment on the overall structure of the file.
+        Your response can cover the questions such as,
+        "Do sections need clearer headings? Are there any technical terms that might not be understood? Is something missing that is worth discussing before adding?"
+      placeholder: Please use bullets (* or -) and filled checkboxes ([x]) as necessary.
+    validations:
+      required: true
+  - type: textarea
+    id: helpers
+    attributes:
+      label: Who can help?
+      description: |
+        If you know the original author the chapter/section, it may be useful to tag them here for their input.
+      placeholder: |
+        - …
+        - …
+  - type: checkboxes
+    id: updates
+    attributes:
+      label: Updates
+      description: |
+        Please update the initial issue with important updates (for example, actions or decisions taken) regularly so that all the important information is available at one glance.
+        You may use the checklist here to get started, feel free to modify this list.
+      options:
+        - label: "First set of edits to chapter/subchapter"
+        - label: "Proofread"
+        - label: "Request reviews"
+        - label: "Address reviews"
+        - label: "Merge to main branch"

.github/ISSUE_TEMPLATE/new_chapter.yml → .github/ISSUE_TEMPLATE/03_new_chapter.yml

@@ -1,17 +1,18 @@
-name: "\U0001F4D6 New Chapter Template"
-description: Template for proposing a new chapter
-title: "[NEW CHAPTER] - <TOPIC>"
-labels: book
+name: "\U0001F4D6 New chapter"
+description: Propose a new chapter
+title: "[CHAPTER]: chapter"
+labels: [book]
 body:
 - type: markdown
   attributes:
-    value: "Please complete the following sections to propose a new chapter. If you have the necessary permissions, please also assign the appropriate label (or labels) to your issue, otherwise a _Turing Way_ team member will assign labels later."
+    value: |
+      Please complete the following sections to propose a new chapter.
 - type: input
   id: title
   attributes:
     label: Title
     description: |
-      Please provide a proposed title.
+      Your proposed chapter's title.
   validations:
     required: true
 - type: input
@@ -27,13 +28,17 @@ body:
   attributes:
     label: Draft
     description: |
-      Please provide a link to your draft. This might be in a document such as a hackmd or a new file on your GitHub branch. If you already have a PR you can update the PR with a keyword to link directly to this issue - see instructions [here](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). You can provide this later if you haven't started yet!
+      Please provide a link to your draft.
+      This might be in a document such as a hackmd or a new file on your GitHub branch.
+      If you already have a PR you can update the PR with a keyword to link directly to this issue - see instructions [here](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
+      You can provide this later if you haven't started yet!
 - type: textarea
   id: summary
   attributes:
     label: Summary of proposed chapter
     description: |
       Please provide a detailed description of the chapter you are proposing.
+
       - What is the purpose of your chapter?
       - Why are you proposing it?
   validations:
@@ -42,12 +47,18 @@ body:
   id: resources
   attributes:
     label: Resources
-    description: List and describe any external resources that may be helpful when writing the chapter. We suggest using bullets (-) and/or checkboxes (- [ ]).
+    description: List and describe any external resources that may be helpful when writing the chapter.
+    placeholder: |
+      - …
+      - …
 - type: textarea
   id: who_can_help
   attributes:
     label: Who can help?
-    description: We suggest using bullets (-) and/or checkboxes (- [ ]).
+    description: Suggest people who can help.
+    placeholder: |
+      - …
+      - …
 - type: checkboxes
   id: updates
   attributes:

.github/ISSUE_TEMPLATE/04_request_translation.yml

@@ -0,0 +1,45 @@
+name: "\U0001F4D1 Request Translation"
+description: Propose a translation
+title: "[TRANSLATION]:"
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Use this template to propose a tnraslation.
+  - type: textarea
+    attributes:
+      label: Summary
+      description: |
+        Please provide a detailed description of the language/languages that you want to translate to and the chapters that you would like to translate.
+        Please provide as much context as possible and link to related issues and/or pull requests.
+        Providing links to sections you're referencing for clarity is highly encouraged.
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Target language
+      description: What is/are the target language/languages?
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Translation options
+      options:
+        - label: I wish to be manager in Crowdin for entries in this language.
+        - label: I will only proofread translation for this language.
+        - label: I have a local translation to be uploaded to the Translation Memory?
+  - type: textarea
+    attributes:
+      label: Chapters to translation
+      description: Which chapters do you want to translate?
+      placeholder: |
+        - …
+        - …
+  - type: textarea
+    id: who_can_help
+    attributes:
+      label: Who can help?
+      description: Suggest people who can help.
+      placeholder: |
+        - …
+        - …

.github/ISSUE_TEMPLATE/05_general.yml

@@ -0,0 +1,32 @@
+name: "\u2728 General"
+description: Have a different idea?
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please complete the following sections when you open an issue.
+  - type: textarea
+    attributes:
+      label: Summary
+      description: |
+        Please provide a detailed description of the change or addition you are proposing, or the question you're asking.
+        Please provide as much context as possible and link to related issues and/or pull requests.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: What needs to be done?
+      description:
+        We suggest using bullets (indicated by * or -) and filled checkboxes [x] here.
+      placeholder: |
+        - [ ] …
+        - [ ] …
+  - type: textarea
+    attributes:
+      label: Who can help?
+      description: |
+        Suggest people who can help.
+      render: markdown
+      placeholder: |
+        - …
+        - …

.github/ISSUE_TEMPLATE/BOOK_DASH_CHECKLIST.md → .github/ISSUE_TEMPLATE/11_book_dash_checklist.md

@@ -32,13 +32,13 @@ We have created the following checklists, which are chronologically structured t
 - [ ] Set up an online platform ([Zoom](https://zoom.us/), or other accessible software) for remote collaboration
 - [ ] Copy the HackMD index page for the event using last round for reference: https://hackmd.io/@turingway/bookdash-nov2022-index
 - [ ] Update shared HackMD for pre-event calls<ch-template-bookdash-precall>, [book dash event](https://the-turing-way.netlify.app/community-handbook/templates/template-bookdash-notes.html#ch-template-bookdash-notes) and [feedback](https://the-turing-way.netlify.app/community-handbook/templates/template-bookdash-feedback.html#ch-template-bookdash-feedback)
-- [ ] Copy the Eventbrite page from last round for the Book Dash attendees - set a registration code 
+- [ ] Copy the Eventbrite page from last round for the Book Dash attendees - set a registration code
 - [ ] Send a reminder in next newsletters with more details if needed
 - [ ] Copy the share out Eventbrite page (2 sessions)
 - [ ] Clearly state the following information in an application form and later communicate by email with the selected participants:
-  -   what financial support will be available for either online or in-person events 
-  -  What arrangements will be available online (such as online helpers and designated mentors) or on-site (such as quiet room and child care) for in-person events 
-  -  Include accessibility information such as live captioning for in-person events and quiet room/child nursing room for in-person events 
+  -   what financial support will be available for either online or in-person events
+  -  What arrangements will be available online (such as online helpers and designated mentors) or on-site (such as quiet room and child care) for in-person events
+  -  Include accessibility information such as live captioning for in-person events and quiet room/child nursing room for in-person events
   - Mention the maximum limit for financial support requests for online (such as for headphones) and in-person (such as for travel and accommodation) events
 
 **During and after the application phase**

.github/ISSUE_TEMPLATE/FIRESIDE_CHAT_CHECKLIST.md → .github/ISSUE_TEMPLATE/12_fireside_chat_checklist.md

@@ -32,7 +32,7 @@ Register here to attend: [add registration page link].
 - [ ] Announce at least 3-4 weeks in advance on Slack, Newsletter, Twitter and different talks
 - [ ] Add information to the Intro hackmd: https://hackmd.io/@turingway/demo-intro
 - [ ] Hosts will define an agenda and questions for the session - hosts will also allocate some questions for each other to speak on
-- [ ] Set another check-in at least 2 weeks in advance to touch base and discuss the plans and questions with the speakers - assign 1-2 questions for each speaker to begin 
+- [ ] Set another check-in at least 2 weeks in advance to touch base and discuss the plans and questions with the speakers - assign 1-2 questions for each speaker to begin
 - [ ] Plan with cohost who will ask which question, how you will time keep, what channel you will use to ask questions to each other privately, who will monitor the chat (maybe ask someone outside this group to help with note taking and chat monitoring)
 - [ ] Update the calendar invite with Zoom, Etherpad and Eventbrite -- encouraging them to share the Eventbrite page in their network
 - [ ] Identify someone from the community who can do the introduction of The Turing Way, code of conduct reminder and pass it to the speakers
@@ -51,7 +51,7 @@ Register here to attend: [add registration page link].
 - [ ] Speakers will make sure that everyone on the panel has had an equal chance to discuss and share their opinions
 - [ ] Any question from the chat is copied over the Etherpad, in the last 10 minutes publically posed question can be asked
 - [ ] The recorded session finishes with a short closing arguments from each speaker and host
-- [ ] After the recorded part of the discussion (60-75 minutes), all participants are reminded of the next stage of unrecorded discussion informally with the speakers 
+- [ ] After the recorded part of the discussion (60-75 minutes), all participants are reminded of the next stage of unrecorded discussion informally with the speakers
 - [ ] Hosts close the call after 90 minutes of the session (with 15-30 minutes unrecorded discussion)
 
 ## After the session
@@ -61,7 +61,7 @@ Register here to attend: [add registration page link].
 - [ ] Download the video from Zoom and edit the live transcription (proofread cc)
 - [ ] Upload the video on The Turing Way youtube - label and annotate well, and add the flyer as the video's front page
 - [ ] Share the published videos with the speakers
-- [ ] Summarise the session to add to The Turing Way -- invite someone from the community who could do that 
+- [ ] Summarise the session to add to The Turing Way -- invite someone from the community who could do that
 - [ ] Promote the video via Slack, Newsletter, Twitter
 - [ ] Send a thank you email to the Eventbrite participants sharing the video and inviting any ideas and suggestions for improvement via a standard feedback form
 - [ ] Update the book chapter and templates if needed