-
Notifications
You must be signed in to change notification settings - Fork 666
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2106 from Remi-Gau/remi-issue_forms
[INFRA] update the issue template to use the new "forms" format
- Loading branch information
Showing
16 changed files
with
244 additions
and
398 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: | | ||
| - … | ||
| - … |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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: | | ||
| - … | ||
| - … |
4 changes: 2 additions & 2 deletions
4
.github/ISSUE_TEMPLATE/give_a_talk.yml → .github/ISSUE_TEMPLATE/06_give_a_talk.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.