From d4aef8107c7928ded76fafbbcf24e3a4989de4f1 Mon Sep 17 00:00:00 2001 From: Kevin O Gorman Date: Sun, 22 Jul 2018 00:18:09 -0400 Subject: [PATCH 1/4] Adds issue and PR templates --- .github/ISSUE_TEMPLATE | 22 ++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE | 38 +++++++++++++++++++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE create mode 100644 .github/PULL_REQUEST_TEMPLATE diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE new file mode 100644 index 0000000..55894b4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE @@ -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! + + diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 0000000..77a8ff8 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -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! + + From 7354f9a57e7939a351120fca15bb5a5102bdc2df Mon Sep 17 00:00:00 2001 From: Kevin O Gorman Date: Sun, 22 Jul 2018 00:28:00 -0400 Subject: [PATCH 2/4] Renamed files to include .md extension --- .github/{ISSUE_TEMPLATE => ISSUE_TEMPLATE.md} | 0 .github/{PULL_REQUEST_TEMPLATE => PULL_REQUEST_TEMPLATE.md} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename .github/{ISSUE_TEMPLATE => ISSUE_TEMPLATE.md} (100%) rename .github/{PULL_REQUEST_TEMPLATE => PULL_REQUEST_TEMPLATE.md} (100%) diff --git a/.github/ISSUE_TEMPLATE b/.github/ISSUE_TEMPLATE.md similarity index 100% rename from .github/ISSUE_TEMPLATE rename to .github/ISSUE_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE.md similarity index 100% rename from .github/PULL_REQUEST_TEMPLATE rename to .github/PULL_REQUEST_TEMPLATE.md From 7c1d580c9c62eb5cbd38a0fdbe4a9b0c6b0b8a59 Mon Sep 17 00:00:00 2001 From: Ryan Pitts Date: Mon, 23 Jul 2018 10:20:37 -0700 Subject: [PATCH 3/4] normalize some line spacing --- .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 77a8ff8..0a5f727 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,23 +2,28 @@ Ready for review / Work in progress + ## Description of Changes Fixes Issue # -- [ ] New Lesson Plan +- [ ] New lesson plan - [ ] Correction or update to existing plan -- [ ] New Resource listing +- [ ] 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.) @@ -34,5 +39,3 @@ Fixes Issue # ## 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! - - From 5c1f57580caa62abbc66c504c09e13d4cb7b218a Mon Sep 17 00:00:00 2001 From: Ryan Pitts Date: Mon, 23 Jul 2018 11:05:08 -0700 Subject: [PATCH 4/4] add suggestions about creating issues, multple PRs --- .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0a5f727..871635d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,3 +1,8 @@ +Hi, and thanks for taking the time to create a pull request! The information below will help us work with you to add your contributions to the Guide. Two notes before we get started: + +* If this repo doesn't already have a GitHub issue for the topic of your pull request, we invite you to [create one](https://github.com/OpenNewsLabs/field-guide-security-training-newsroom/issues/new). That gives us a great place to ask any questions. +* Lots of small pull requests are better than one big one! It's totally fine for a single pull request to touch multiple files, but if you're doing more than one thing—for example, fixing a typo in a lesson plan _and_ adding a couple links to the resource list—splitting into multiple pull requests makes sure that easy fixes aren't blocked by updates that need a bit more discussion. + ## Status Ready for review / Work in progress