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

Adds issue and PR templates #1

Merged
merged 1 commit into from
Jul 22, 2018
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Hi, and thanks for taking the time to create an issue! The information we look for usually falls into the categories below - please use them as a guide.


## Description

A clear and concise description of the issue.


## Issue type

- [ ] proposal for a new lesson plan
- [ ] update to an existing lesson plan or the resources list
- [ ] bug/correction for existing guide content
- [ ] suggestions for improvement
- [ ] other - please specify


## Introduce yourself (optional)

If this is your first time contributing an issue to the Guide, we would love to learn a little bit more about you and what motivated you to get involved - but it isn't a requirement!


38 changes: 38 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## Status

Ready for review / Work in progress

## Description of Changes

Fixes Issue #

- [ ] New Lesson Plan
- [ ] Correction or update to existing plan
- [ ] New Resource listing


## If this PR contains a new lesson plan:

### What is the tool or process that it describes?
(Example: this lesson plan describes Semaphor, a proprietary messaging tool similar to Signal that can be used to communicate securely)

### What threat model does it assume will apply to users of the tool or process?
(Example: a journalist working on a case involving organized crime in the USA may have information on source identities. This information is valuable to the targets of the investigation. They will have the ability to follow the journalist, physically break in to the journalist's home or office, and contact the journalist and their friends and family and intimidate them with the goal of uncovering source identities. If they get source identities the sources will no longer cooperate with the journalist and will be in physical danger. Semaphor would allow the journalist and sources to communicate securely, which would help to protect their identities.)

### In what circumstances should the tool or process NOT be used?

(Example: If the journalist cannot reasonably ensure the safety of their electronic devices with the Semaphor client, or if the source cannot use Semaphor without arising suspicion.)


## If this PR contains an update to an existing plan:

- [ ] The update corrects a security error in the plan
- [ ] The update improves the overall quality of the lesson plan
- [ ] The update is a minor correction


## Introduce yourself?

If this is your first time contributing an issue to the Guide, we would love to learn a little bit more about you and what motivated you to get involved - but it isn't a requirement!