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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/CHAPTER_ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: New Chapter Template
name: "\U0001F4D6 New Chapter Template"
about: Template for proposing a new chapter
title:
labels:
Expand All @@ -8,6 +8,7 @@ assignees: ''
---

## Detailed description

* This issue is a place to discuss matters relating to the writing of the chapter on _chapter_topic_.
* This chapter is being written in _pull_request_number_
* This chapter is being developed on the _chapter_topic_ branch.
Expand All @@ -19,6 +20,7 @@ assignees: ''
### Discussion points/related issues

## Current status

This chapter is empty. If anyone would like to make a start they are more than welcome to do so.

- [ ] Write chapter outline
Expand All @@ -30,4 +32,5 @@ This chapter is empty. If anyone would like to make a start they are more than w
- [ ] Merge to master branch.

## Updates
To avoid that others have to read through the full thread of comments, update the initial issue with important updates (e.g. decisions taken) regularly so that all the important information is available at one glance.

<!-- To avoid that others have to read through the full thread of comments, update the initial issue with important updates (e.g. decisions taken) regularly so that all the important information is available at one glance. -->
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: General
about: General issue
name: "\u2728 General"
about: Have a different idea?
title:
labels:
assignees: ''
Expand Down
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: "\U0001F41B Bug report"
about: Create a report to help us repair something that is currently broken
title: "[BUG]"
labels: 'bug'
assignees: ''

---
<!-- Thank you for contributing. These HTML commments will not render in the issue, but you can delete them once you've read them if you prefer! -->

### Bug description
<!-- Use this section to clearly and concisely describe the bug.
We suggest using bullets (indicated by * or -) or checkboxes [ ] (filled checkbox [x]) here -->

- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*

#### Expected behaviour
<!-- Tell us what you thought would happen.
We suggest using bullets (indicated by * or -) or checkboxes [ ] (filled checkbox [x]) here -->

- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*

#### Actual behaviour
<!-- Tell us what actually happens.
We suggest using bullets (indicated by * or -) or checkboxes [ ] (filled checkbox [x]) here -->

- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*

### How to reproduce
<!-- Use this section to describe the steps that a user would take to experience this bug.
For example:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error -->

### Your personal set up
<!-- Tell us a little about the system you're using or tested this bug in. -->

- OS:
<!-- Such as linux or OSX.
We suggest using bullets (indicated by * or -) or checkboxes [ ] (filled checkbox [x]) here -->

- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*

- Browser:
<!-- Such as Chrome or Firefox.
We suggest using bullets (indicated by * or -) or checkboxes [ ] (filled checkbox [x]) here -->

- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
- [ ] *Lorem ipsum dolor sit amet, consectetur adipiscing.*
7 changes: 7 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
contact_links:
- name: "\u2615 Collaboration Cafe"
url: https://github.com/alan-turing-institute/the-turing-way/blob/master/project_management/online-collaboration-cafe.md
about: Sign up for mentored sprints and co-working sessions with Turing Way community members
- name: "\U0001F5E3 All other questions and general chat"
url: https://gitter.im/alan-turing-institute/the-turing-way
about: Chat with the Turing Way community on Gitter