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

Issue templates #33

Closed
5 tasks done
Ismael-KG opened this issue Nov 29, 2021 · 5 comments
Closed
5 tasks done

Issue templates #33

Ismael-KG opened this issue Nov 29, 2021 · 5 comments
Assignees
Labels
To-do list Tasks that need doing (some might even be easy!)

Comments

@Ismael-KG
Copy link
Collaborator

Ismael-KG commented Nov 29, 2021

This is a task from #31

The point here is to design templates that are clear as to what different contributions might look like, as per Protocol 3. There should be templates for:

  • Engineering
  • Policy-making
  • Communications
  • Conceptualisation

"Ideation" contributions do not need their own issues because they result from sustainability-related discussions. The remaining stories contributions do not need issues because stories can be and improved offline, on HackMD or using the relevant conceptualisation issue.

  • Templates are added from the main repo page >> Settings >> Features >> Issues.

The "lightbulb moments 💡" template serves as a template for all others:

## Template name
Light bulb Moments 💡

## About
Did you just have a super idea that needs working on? Use this template to jot down your thoughts!

## Template content
### Title
<!-- Type a short title for this idea. Make sure to change the name of the issue by replacing [TITLE] with what you write here! -->

### Elevator Pitch
<!-- Type below a quick intro to this awesome idea you just had. Try keeping it under 240 characters. -->

### Justification
<!-- Explain why this idea is so great. For example, what gap does it fill and what do we learn from it? -->

### Unformed Thoughts
<!-- What stories, labels, categories or themes does this 💡 relate to? Are there any references you can make to show the value of your idea? -->

## Issue default title
Light bulb Moment 💡 [TITLE]

## Assignees
@[yourself]

## Labels

@Ismael-KG Ismael-KG added the To-do list Tasks that need doing (some might even be easy!) label Nov 29, 2021
@Ismael-KG
Copy link
Collaborator Author

Ismael-KG commented Nov 29, 2021

## Template name
Engineering 🧰

## About
How can we improve the experience of contributors and make _The Timeline_ more accessible?

## Template content
### Title
<!-- Type a short title for this idea. Make sure to change the name of the issue by replacing [TITLE] with what you write here! -->

### Elevator Pitch
<!-- Type below a quick intro to this awesome idea you just had. Try keeping it under 240 characters. -->

### Justification
<!-- Explain why this idea is so great. For example, what [contribution type](https://github.com/Ismael-KG/A-History-of-Research-Ethics/blob/main/Protocols.md#protocol-3-contribution-types) does it make easier? Or how does it make engaging with _The Timeline_ more accessible? -->

### Skills
<!-- What technical skills do you envisage being most relevant to designing and implementing the idea? Use the below table to list skills and explain how they will be useful. Try to keep the list below 6. -->
| Skill | Rationale |
| --- | --- |
| [Skill 1] | [Rationale 1] |
| [Skill 2] | [Rationale 2] |
| [Skill 3] | [Rationale 3] |
| [Skill 4] | [Rationale 4] |
| [Skill 5] | [Rationale 5] |

## Issue default title
Engineering 🧰 [TITLE]

## Assignees


## Labels
Help Wanted

@Ismael-KG
Copy link
Collaborator Author

Ismael-KG commented Nov 29, 2021

## Template name
Policy-making ℹ️

## About
Use this template to suggest improvements to protocols, or new protocols.

## Template content
### Title
<!-- Type a short title for this idea. If you are suggesting a new protocol, the title must start with "New:". Make sure to change the name of the issue by replacing [TITLE] with what you write here! -->


### Elevator Pitch
<!-- Type below a quick intro to this awesome idea you just had. Try keeping it under 240 characters. -->


### Justification
<!-- Explain why this idea is so great. For example, what protocol is currently missing, or what is unclear in a current protocol? -->


### Unformed Thoughts
<!-- What sources ℹ️ can be drawn on to create or improve the protocol you suggest? Are there any policies in the wild that can be drawn on? How will the changes you suggest affect other protocols? -->


## Issue default title
Policy-making ℹ️ [TITLE]

## Assignees


## Labels
Help wanted

@Ismael-KG
Copy link
Collaborator Author

Ismael-KG commented Nov 29, 2021

## Template name
Communications 🌐

## About
Where can _The Timeline_ be shared? Are there any sites it has been referenced on?

## Template content
### Title
<!-- Type a short title for this idea. Make sure to change the name of the issue by replacing [TITLE] with what you write here! -->


### Elevator Pitch / Celebrate 🎉 
<!-- Change this section's title depending on whether you are suggesting a change or want to draw attention to references to _The Timeline_. Then share away! If this issue is to celebrate, you can delete the the remaining sections, and don't forget to mention relevant contributors! -->


### Justification
<!-- *Iff* this issue is for an elevator pitch, please describe the intended improvement from your suggestion. Spell out the gaps that will be filled. -->


### Skills
<!-- What technical skills do you envisage being most relevant to designing and implementing the idea? Use the below table to list skills and explain how they will be useful. Try to keep the list below 6. -->
| Skill | Rationale |
| --- | --- |
| [Skill 1] | [Rationale 1] |
| [Skill 2] | [Rationale 2] |
| [Skill 3] | [Rationale 3] |
| [Skill 4] | [Rationale 4] |
| [Skill 5] | [Rationale 5] |

## Issue default title
Communications 🌐 [TITLE]

## Assignees
@[yourself]

## Labels
Help wanted

@Ismael-KG
Copy link
Collaborator Author

Ismael-KG commented Nov 29, 2021

## Template name
Conceptualisation  🖊️

## About
What new story have you thought about? Raise an issue and let's iron out the details together!

## Template content
### Title
<!-- Type a short title for this idea. Make sure to change the name of the issue by replacing [TITLE] with what you write here! -->

### Date or Period 📅
<!-- Please share a date for the event you think _A History of Research Ethics_ should capture. The more precise the date, the better, and it helps if you share a reliable source confirming the date! -->


### Elevator Pitch
<!-- Type below a quick intro to this awesome idea you just had. Try keeping it under 240 characters. -->


### Justification
<!-- Explain why this story is relevant. For example, what ethical questions does it raise, and how? -->


### Unformed Thoughts
<!-- What stories, labels, categories or themes does this story relate to? -->


## Issue default title
Conceptualisation  🖊️ [TITLE]

## Assignees
@[yourself]

## Labels
Help wanted

Ismael-KG added a commit that referenced this issue Nov 29, 2021
Templates created following #33
@Ismael-KG Ismael-KG self-assigned this Nov 29, 2021
@Ismael-KG
Copy link
Collaborator Author

templates now created!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
To-do list Tasks that need doing (some might even be easy!)
Projects
None yet
Development

No branches or pull requests

1 participant