Update Readme and Templates (#37)

keithrfung · keithrfung · commit 98af9c8a2ba6 · 2020-02-13T14:25:13.000-05:00
* Update Readme and template

* Update
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,3 +1,14 @@
+### Issue
+*Link your PR to an issue*
+
+Fixes #___
+
+### Description
+*Please describe your pull request.*
+
+### Testing
+*Describe the best way to test or validate your PR.*
+
 ### Checklist
 🚨Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository.
 
@@ -11,8 +22,4 @@
 - [ ] ❌**AVOID** breaking the continuous integration build.
 - [ ] ❌**AVOID** making significant changes to the overall architecture.
 
-
-### Description
-Please describe your pull request.
-
 💔Thank you!
diff --git a/.postman/postman_environment.local.json b/.postman/postman_environment.local.json
@@ -39,7 +39,7 @@
 		},
 		{
 			"key": "election",
-			"value": "{\n  \"title\": \"Spring Primary\",\n  \"state\": \"State of Wisconsin\",\n  \"county\": {\n    \"id\": \"1\",\n    \"name\": \"Rock County\"\n  },\n  \"date\": \"February 6th, 2020\",\n  \"parties\": [\n    {\n      \"id\": \"0\",\n      \"name\": \"Non-Partisan\",\n      \"abbrev\": \"NP\"\n    },\n    {\n      \"id\": \"1\",\n      \"name\": \"Democrat\",\n      \"abbrev\": \"D\"\n    },\n    {\n      \"id\": \"2\",\n      \"name\": \"Republican\",\n      \"abbrev\": \"R\"\n    }\n  ],\n  \"precincts\": [\n    {\n      \"id\": \"1\",\n      \"name\": \"Fulton Town Hall\"\n    }\n  ],\n  \"contests\": [\n    {\n      \"id\": \"justice-supreme-court\",\n      \"section\": \"Judicial\",\n      \"districtId\": \"1\",\n      \"type\": \"candidate\",\n      \"official_label\": \"Justice of the Supreme Court\",\n      \"title\": \"Justice of the Supreme Court\",\n      \"seats\": 1,\n      \"allowWriteIns\": true,\n      \"candidates\": [\n        {\n          \"id\": \"laurel-clark\",\n          \"name\": \"Laurel Clark\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"les-paul\",\n          \"name\": \"Les Paul\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"georgia-okeeffe\",\n          \"name\": \"Georgia O'Keeffe\",\n\t        \"partyId\": \"0\"\n        }\n      ]\n    },\n    {\n      \"id\": \"referendum-michigan-up\",\n      \"section\": \"Referenda\",\n      \"districtId\": \"2\",\n      \"type\": \"yesno\",\n      \"short_title\": \"The Michigan Question\",\n      \"title\": \"Proposition M: The Michigan Question\",\n      \"description\": \"Should the State of Wisconsin purchase, from the State of Michigan, the Upper Peninsula, for the purchase price of $1 Billion?\"\n    },\n    {\n      \"id\": \"milton-school-board\",\n      \"section\": \"Milton School District\",\n      \"districtId\": \"3\",\n      \"type\": \"candidate\",\n      \"title\": \"School Board Member\",\n      \"seats\": 2,\n      \"allowWriteIns\": true,\n      \"candidates\": [\n        {\n          \"id\": \"jim-lovell\",\n          \"name\": \"Jim Lovell\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"william-rehnquist\",\n          \"name\": \"William Rehnquist\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"debbie-mccormick\",\n          \"name\": \"Debbie McCormick\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"clyde-stubblefield\",\n          \"name\": \"Clyde Stubblefield\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"frank-lloyd-wright\",\n          \"name\": \"Frank Lloyd Wright\",\n\t        \"partyId\": \"0\"\n        }\n      ]\n    }\n  ],\n  \"districts\": [\n    {\n      \"id\": \"1\",\n      \"name\": \"State Of Wisconsin\"\n    },\n    {\n      \"id\": \"2\",\n      \"name\": \"Referenda\"\n    },\n    {\n      \"id\": \"3\",\n      \"name\": \"Milton School District\"\n    }\n  ],\n  \"ballotStyles\": [\n    {\n      \"id\": \"1\",\n      \"precincts\": [\n        \"1\"\n      ],\n      \"districts\": [\n        \"1\",\n\t      \"2\"\n      ]\n    },\n    {\n      \"id\": \"2\",\n      \"precincts\": [\n        \"1\"\n      ],\n      \"districts\": [\n        \"1\",\n\t      \"3\"\n      ]\n    }\n  ],\n  \"sealURL\": \"/seals/Seal_of_Wisconsin.svg\"\n}",
+			"value": "{\n  \"title\": \"Spring Primary\",\n  \"state\": \"State of Hamilton\",\n  \"county\": {\n    \"id\": \"1\",\n    \"name\": \"Boulder County\"\n  },\n  \"date\": \"February 6th, 2020\",\n  \"parties\": [\n    {\n      \"id\": \"0\",\n      \"name\": \"Non-Partisan\",\n      \"abbrev\": \"NP\"\n    },\n    {\n      \"id\": \"1\",\n      \"name\": \"Democrat\",\n      \"abbrev\": \"D\"\n    },\n    {\n      \"id\": \"2\",\n      \"name\": \"Republican\",\n      \"abbrev\": \"R\"\n    }\n  ],\n  \"precincts\": [\n    {\n      \"id\": \"1\",\n      \"name\": \"Town Hall\"\n    }\n  ],\n  \"contests\": [\n    {\n      \"id\": \"justice-supreme-court\",\n      \"section\": \"Judicial\",\n      \"districtId\": \"1\",\n      \"type\": \"candidate\",\n      \"official_label\": \"Justice of the Supreme Court\",\n      \"title\": \"Justice of the Supreme Court\",\n      \"seats\": 1,\n      \"allowWriteIns\": true,\n      \"candidates\": [\n        {\n          \"id\": \"laurel-clark\",\n          \"name\": \"Laurel Clark\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"les-paul\",\n          \"name\": \"Les Paul\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"georgia-okeeffe\",\n          \"name\": \"Georgia O'Keeffe\",\n\t        \"partyId\": \"0\"\n        }\n      ]\n    },\n    {\n      \"id\": \"referendum-michigan-up\",\n      \"section\": \"Referenda\",\n      \"districtId\": \"2\",\n      \"type\": \"yesno\",\n      \"short_title\": \"The Michigan Question\",\n      \"title\": \"Proposition M: The Michigan Question\",\n      \"description\": \"Should the State of Hamilton purchase, from the State of Michigan, the Upper Peninsula, for the purchase price of $1 Billion?\"\n    },\n    {\n      \"id\": \"milton-school-board\",\n      \"section\": \"Milton School District\",\n      \"districtId\": \"3\",\n      \"type\": \"candidate\",\n      \"title\": \"School Board Member\",\n      \"seats\": 2,\n      \"allowWriteIns\": true,\n      \"candidates\": [\n        {\n          \"id\": \"jim-lovell\",\n          \"name\": \"Jim Lovell\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"william-rehnquist\",\n          \"name\": \"William Rehnquist\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"debbie-mccormick\",\n          \"name\": \"Debbie McCormick\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"clyde-stubblefield\",\n          \"name\": \"Clyde Stubblefield\",\n\t        \"partyId\": \"0\"\n        },\n        {\n          \"id\": \"frank-lloyd-wright\",\n          \"name\": \"Frank Lloyd Wright\",\n\t        \"partyId\": \"0\"\n        }\n      ]\n    }\n  ],\n  \"districts\": [\n    {\n      \"id\": \"1\",\n      \"name\": \"State Of Hamilton\"\n    },\n    {\n      \"id\": \"2\",\n      \"name\": \"Referenda\"\n    },\n    {\n      \"id\": \"3\",\n      \"name\": \"Milton School District\"\n    }\n  ],\n  \"ballotStyles\": [\n    {\n      \"id\": \"1\",\n      \"precincts\": [\n        \"1\"\n      ],\n      \"districts\": [\n        \"1\",\n\t      \"2\"\n      ]\n    },\n    {\n      \"id\": \"2\",\n      \"precincts\": [\n        \"1\"\n      ],\n      \"districts\": [\n        \"1\",\n\t      \"3\"\n      ]\n    }\n  ],\n  \"sealURL\": \"/seals/Seal_of_Wisconsin.svg\"\n}",
 			"enabled": true
 		},
 		{
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,18 @@
+# Contributing
+
+This project welcomes contributions and suggestions. Most contributions require
+you to agree to a Contributor License Agreement (CLA) declaring that you have
+the right to, and actually do, grant us the rights to use your contribution. For
+details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether
+you need to provide a CLA and decorate the PR appropriately (e.g., status check,
+comment). Simply follow the instructions provided by the bot. You will only need
+to do this once across all repos using our CLA.
+
+This project has adopted the
+[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the
+[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any
+additional questions or comments.
diff --git a/README.md b/README.md
@@ -1,45 +1,11 @@
----
-page_type: sample
-languages:
-- csharp
-products:
-- dotnet
-description: "Add 150 character max description"
-urlFragment: "update-this-to-unique-url-stub"
----
-
-# Official Microsoft Sample
+![Microsoft Defending Democracy Program: ElectionGuard](images/electionguard-banner.svg)
 
-<!-- 
-Guidelines on README format: https://review.docs.microsoft.com/help/onboard/admin/samples/concepts/readme-template?branch=master
-
-Guidance on onboarding samples to docs.microsoft.com/samples: https://review.docs.microsoft.com/help/onboard/admin/samples/process/onboarding?branch=master
-
-Taxonomies for products and languages: https://review.docs.microsoft.com/new-hope/information-architecture/metadata/taxonomies?branch=master
--->
-
-Give a short description for your sample here. What does it do and why is it important?
-
-## Contents
-
-Outline the file contents of the repository. It helps users navigate the codebase, build configuration and any related assets.
+#  🗳️ ElectionGuard Web API
 
-| File/folder       | Description                                |
-|-------------------|--------------------------------------------|
-| `src`             | Sample source code.                        |
-| `.gitignore`      | Define what to ignore at commit time.      |
-| `CHANGELOG.md`    | List of changes to the sample.             |
-| `CONTRIBUTING.md` | Guidelines for contributing to the sample. |
-| `README.md`       | This README file.                          |
-| `LICENSE`         | The license for the sample.                |
+![package](https://github.com/microsoft/electionguard-web-api/workflows/Package/badge.svg)
+[![license](https://img.shields.io/github/license/microsoft/electionguard-web-api)](LICENSE)
 
-## Prerequisites
-
-Outline the required components and tools that a user might need to have on their machine in order to run the sample. This can be anything from frameworks, SDKs, OS versions or IDE releases.
-
-## Setup
-
-Explain how to prepare the sample once the user clones or downloads the repository. The section should outline every step necessary to install dependencies and set up any settings (for example, API keys and output folders).
+This is an API that interacts with admin encrypter devices to perform ballot encryption, casting, spoiling, and tallying. This makes use of the C# Nuget package.
 
 ## Runnning the sample
 
@@ -121,15 +87,13 @@ Configuration can be provided in multiple ways
 3. Via `EncryptBallot` - by providing the election configuration with each encrypt ballot request, the provided values will be used to encrypt a specific ballot.
 
 ## Contributing
+Help defend democracy and [contribute to the project](CONTRIBUTING).
 
-This project welcomes contributions and suggestions.  Most contributions require you to agree to a
-Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
-the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+<!-- 
+Guidelines on README format: https://review.docs.microsoft.com/help/onboard/admin/samples/concepts/readme-template?branch=master
 
-When you submit a pull request, a CLA bot will automatically determine whether you need to provide
-a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
-provided by the bot. You will only need to do this once across all repos using our CLA.
+Guidance on onboarding samples to docs.microsoft.com/samples: https://review.docs.microsoft.com/help/onboard/admin/samples/process/onboarding?branch=master
+
+Taxonomies for products and languages: https://review.docs.microsoft.com/new-hope/information-architecture/metadata/taxonomies?branch=master
+-->
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
-For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
diff --git a/data/election.json b/data/election.json
@@ -23,7 +23,7 @@
   ],
   "county": {
     "id": "1",
-    "name": "Rock County"
+    "name": "Boulder County"
   },
   "parties": [
     {
@@ -45,13 +45,13 @@
   "precincts": [
     {
       "id": "1",
-      "name": "Fulton Town Hall"
+      "name": "Town Hall"
     }
   ],
   "districts": [
     {
       "id": "1",
-      "name": "State Of Wisconsin"
+      "name": "State Of Hamilton"
     },
     {
       "id": "2",
@@ -90,7 +90,7 @@
       "type": 1
     },
     {
-      "description": "Should the State of Wisconsin purchase, from the State of Michigan, the Upper Peninsula, for the purchase price of $1 Billion?",
+      "description": "Should the State of Hamilton purchase, from the State of Michigan, the Upper Peninsula, for the purchase price of $1 Billion?",
       "id": "referendum-michigan-up",
       "districtId": "2",
       "section": "Referenda",
diff --git a/images/electionguard-banner.svg b/images/electionguard-banner.svg

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@`
`39`	`39`	`},`
`40`	`40`	`{`
`41`	`41`	`"key": "election",`
`42`		- "value": "{\n \"title\": \"Spring Primary\",\n \"state\": \"State of Wisconsin\",\n \"county\": {\n \"id\": \"1\",\n \"name\": \"Rock County\"\n },\n \"date\": \"February 6th, 2020\",\n \"parties\": [\n {\n \"id\": \"0\",\n \"name\": \"Non-Partisan\",\n \"abbrev\": \"NP\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Democrat\",\n \"abbrev\": \"D\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Republican\",\n \"abbrev\": \"R\"\n }\n ],\n \"precincts\": [\n {\n \"id\": \"1\",\n \"name\": \"Fulton Town Hall\"\n }\n ],\n \"contests\": [\n {\n \"id\": \"justice-supreme-court\",\n \"section\": \"Judicial\",\n \"districtId\": \"1\",\n \"type\": \"candidate\",\n \"official_label\": \"Justice of the Supreme Court\",\n \"title\": \"Justice of the Supreme Court\",\n \"seats\": 1,\n \"allowWriteIns\": true,\n \"candidates\": [\n {\n \"id\": \"laurel-clark\",\n \"name\": \"Laurel Clark\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"les-paul\",\n \"name\": \"Les Paul\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"georgia-okeeffe\",\n \"name\": \"Georgia O'Keeffe\",\n\t \"partyId\": \"0\"\n }\n ]\n },\n {\n \"id\": \"referendum-michigan-up\",\n \"section\": \"Referenda\",\n \"districtId\": \"2\",\n \"type\": \"yesno\",\n \"short_title\": \"The Michigan Question\",\n \"title\": \"Proposition M: The Michigan Question\",\n \"description\": \"Should the State of Wisconsin purchase, from the State of Michigan, the Upper Peninsula, for the purchase price of $1 Billion?\"\n },\n {\n \"id\": \"milton-school-board\",\n \"section\": \"Milton School District\",\n \"districtId\": \"3\",\n \"type\": \"candidate\",\n \"title\": \"School Board Member\",\n \"seats\": 2,\n \"allowWriteIns\": true,\n \"candidates\": [\n {\n \"id\": \"jim-lovell\",\n \"name\": \"Jim Lovell\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"william-rehnquist\",\n \"name\": \"William Rehnquist\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"debbie-mccormick\",\n \"name\": \"Debbie McCormick\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"clyde-stubblefield\",\n \"name\": \"Clyde Stubblefield\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"frank-lloyd-wright\",\n \"name\": \"Frank Lloyd Wright\",\n\t \"partyId\": \"0\"\n }\n ]\n }\n ],\n \"districts\": [\n {\n \"id\": \"1\",\n \"name\": \"State Of Wisconsin\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Referenda\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Milton School District\"\n }\n ],\n \"ballotStyles\": [\n {\n \"id\": \"1\",\n \"precincts\": [\n \"1\"\n ],\n \"districts\": [\n \"1\",\n\t \"2\"\n ]\n },\n {\n \"id\": \"2\",\n \"precincts\": [\n \"1\"\n ],\n \"districts\": [\n \"1\",\n\t \"3\"\n ]\n }\n ],\n \"sealURL\": \"/seals/Seal_of_Wisconsin.svg\"\n}",
	`42`	+ "value": "{\n \"title\": \"Spring Primary\",\n \"state\": \"State of Hamilton\",\n \"county\": {\n \"id\": \"1\",\n \"name\": \"Boulder County\"\n },\n \"date\": \"February 6th, 2020\",\n \"parties\": [\n {\n \"id\": \"0\",\n \"name\": \"Non-Partisan\",\n \"abbrev\": \"NP\"\n },\n {\n \"id\": \"1\",\n \"name\": \"Democrat\",\n \"abbrev\": \"D\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Republican\",\n \"abbrev\": \"R\"\n }\n ],\n \"precincts\": [\n {\n \"id\": \"1\",\n \"name\": \"Town Hall\"\n }\n ],\n \"contests\": [\n {\n \"id\": \"justice-supreme-court\",\n \"section\": \"Judicial\",\n \"districtId\": \"1\",\n \"type\": \"candidate\",\n \"official_label\": \"Justice of the Supreme Court\",\n \"title\": \"Justice of the Supreme Court\",\n \"seats\": 1,\n \"allowWriteIns\": true,\n \"candidates\": [\n {\n \"id\": \"laurel-clark\",\n \"name\": \"Laurel Clark\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"les-paul\",\n \"name\": \"Les Paul\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"georgia-okeeffe\",\n \"name\": \"Georgia O'Keeffe\",\n\t \"partyId\": \"0\"\n }\n ]\n },\n {\n \"id\": \"referendum-michigan-up\",\n \"section\": \"Referenda\",\n \"districtId\": \"2\",\n \"type\": \"yesno\",\n \"short_title\": \"The Michigan Question\",\n \"title\": \"Proposition M: The Michigan Question\",\n \"description\": \"Should the State of Hamilton purchase, from the State of Michigan, the Upper Peninsula, for the purchase price of $1 Billion?\"\n },\n {\n \"id\": \"milton-school-board\",\n \"section\": \"Milton School District\",\n \"districtId\": \"3\",\n \"type\": \"candidate\",\n \"title\": \"School Board Member\",\n \"seats\": 2,\n \"allowWriteIns\": true,\n \"candidates\": [\n {\n \"id\": \"jim-lovell\",\n \"name\": \"Jim Lovell\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"william-rehnquist\",\n \"name\": \"William Rehnquist\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"debbie-mccormick\",\n \"name\": \"Debbie McCormick\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"clyde-stubblefield\",\n \"name\": \"Clyde Stubblefield\",\n\t \"partyId\": \"0\"\n },\n {\n \"id\": \"frank-lloyd-wright\",\n \"name\": \"Frank Lloyd Wright\",\n\t \"partyId\": \"0\"\n }\n ]\n }\n ],\n \"districts\": [\n {\n \"id\": \"1\",\n \"name\": \"State Of Hamilton\"\n },\n {\n \"id\": \"2\",\n \"name\": \"Referenda\"\n },\n {\n \"id\": \"3\",\n \"name\": \"Milton School District\"\n }\n ],\n \"ballotStyles\": [\n {\n \"id\": \"1\",\n \"precincts\": [\n \"1\"\n ],\n \"districts\": [\n \"1\",\n\t \"2\"\n ]\n },\n {\n \"id\": \"2\",\n \"precincts\": [\n \"1\"\n ],\n \"districts\": [\n \"1\",\n\t \"3\"\n ]\n }\n ],\n \"sealURL\": \"/seals/Seal_of_Wisconsin.svg\"\n}",
`43`	`43`	`"enabled": true`
`44`	`44`	`},`
`45`	`45`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`],`
`24`	`24`	`"county": {`
`25`	`25`	`"id": "1",`
`26`		`- "name": "Rock County"`
	`26`	`+ "name": "Boulder County"`
`27`	`27`	`},`
`28`	`28`	`"parties": [`
`29`	`29`	`{`
`@@ -45,13 +45,13 @@`
`45`	`45`	`"precincts": [`
`46`	`46`	`{`
`47`	`47`	`"id": "1",`
`48`		`- "name": "Fulton Town Hall"`
	`48`	`+ "name": "Town Hall"`
`49`	`49`	`}`
`50`	`50`	`],`
`51`	`51`	`"districts": [`
`52`	`52`	`{`
`53`	`53`	`"id": "1",`
`54`		`- "name": "State Of Wisconsin"`
	`54`	`+ "name": "State Of Hamilton"`
`55`	`55`	`},`
`56`	`56`	`{`
`57`	`57`	`"id": "2",`
`@@ -90,7 +90,7 @@`
`90`	`90`	`"type": 1`
`91`	`91`	`},`
`92`	`92`	`{`
`93`		`- "description": "Should the State of Wisconsin purchase, from the State of Michigan, the Upper Peninsula, for the purchase price of $1 Billion?",`
	`93`	`+ "description": "Should the State of Hamilton purchase, from the State of Michigan, the Upper Peninsula, for the purchase price of $1 Billion?",`
`94`	`94`	`"id": "referendum-michigan-up",`
`95`	`95`	`"districtId": "2",`
`96`	`96`	`"section": "Referenda",`