📄 Update Readme and templates (#6)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: "\U0001F41B Bug Report"
+about: "If something isn't working as expected"
+title: ''
+labels: 'i: bug, i: needs triage'
+assignees: ''
+
+---
+
+## Bug Report
+
+**Current Behavior**
+A clear and concise description of the behavior.
+
+**Expected behavior/code**
+A clear and concise description of what you expected to happen (or code).
+
+**Environment**
+- OS: [e.g. OSX 10.13.4, Windows 10]
+- Version: [e.g. 1.0.1]
+
+**Possible Solution**
+<!--- Only if you have suggestions on a fix for the bug -->
+
+**Additional context/Screenshots**
+Add any other context about the problem here. If applicable, add screenshots to help explain.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: "\U0001F680 Feature Request"
+about: "I have a suggestion (and may want to implement it)!"
+title: ''
+labels: 'i: enhancement, i: needs triage'
+assignees: ''
+
+---
+
+## Feature Request
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I have an issue when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen. Add any considered drawbacks.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Teachability, Documentation, Adoption, Migration Strategy**
+If you can, explain how users will be able to use this and possibly write out details for the docs.
+Maybe a screenshot or design?

.github/ISSUE_TEMPLATE/generic_issue.md

@@ -0,0 +1,21 @@
+---
+name: "\U000026A0 Generic Issue"
+about: Report a generic issue that isn't a bug or feature
+title: ''
+labels: 'i: needs triage'
+assignees: ''
+
+---
+
+## Generic Issue
+
+- [ ] Ensure this issue is not a bug report or feature request
+
+**Description**
+A clear and concise description of the issue.
+
+**Possible Solution**
+<!--- Only if you have suggestions for the issue -->
+
+**Additional context/Screenshots**
+Add any other context about the problem here. If applicable, add screenshots to help explain.

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,62 +1,25 @@
-<!--
+### Issue
+*Link your PR to an issue*
 
-Hi! We’re stoked that you would like to submit a pull request!
+Fixes #___
 
-In order to get your pull request reviewed and merged, please fill out as much
-of the below template as you can. Feel fre to ignore any part of this template
-which does not pertain to your code.
+### Description
+*Please describe your pull request.*
 
-If you have any questions, please ask us. We're here to help!
+### Testing
+*Describe the best way to test or validate your PR.*
 
--->
+### Checklist
+🚨Please review the [guidelines for contributing](../CONTRIBUTING.md) to this repository.
 
-<!-- Provide a general summary of the changes in the Title above. -->
+- [ ] 🤔 **CONSIDER** adding a unit test if your PR resolves an issue.
+- [ ] ✅ **DO** check open PR's to avoid duplicates.
+- [ ] ✅ **DO** keep pull requests small so they can be easily reviewed.
+- [ ] ✅ **DO** build locally before pushing.
+- [ ] ✅ **DO** make sure tests pass.
+- [ ] ✅ **DO** make sure any new changes are documented.
+- [ ] ✅ **DO** make sure not to introduce any compiler warnings.
+- [ ] ❌**AVOID** breaking the continuous integration build.
+- [ ] ❌**AVOID** making significant changes to the overall architecture.
 
-## Related Issue(s)
-
-<!-- Please link to the issue(s) where this feature/bug is discussed/reported. -->
-
-Resolves #1
-
-## Description
-
-<!--
-If not clearly described in the related issue(s), describe:
-- Why this change is propsed?
-- What issue/bug does it solve?
--->
-
-## Screenshots/Screencasts
-
-<!-- Copy/paste or drag/drop images/videos here to assist in reviewing this pull request. -->
-
-## Types of changes
-
-<!--
-What types of changes does your code introduce?
-Put an `x` in all the boxes that apply.
--->
-
-- [ ] Bug fix.
-- [ ] New feature or updated functionality.
-
-**Is this a breaking change?** eg. Will this change require updates to existing
-election configuration files?
-
-- [ ] Yes, this is a breaking change.
-
-<!-- If so, describe what will break and steps to fix. -->
-
-## Checklist:
-
-<!-- Put an `x` in all the boxes that apply. -->
-<!-- If unsure about any, don't hesitate to ask. We're here to help! -->
-
-- [ ] This code follows the code style of this project.
-- [ ] This change requires a change to the documentation.
-- [ ] The documentation has been updated accordingly.
-- [ ] I have read the
-      [CONTRIBUTING](https://github.com/votingworks/bmd/blob/master/CONTRIBUTING.md)
-      document.
-- [ ] Tests have been updated to cover new/changed functionality.
-- [ ] All new and existing tests have passed.
+💔Thank you!

CONTRIBUTING.md

@@ -1,10 +1,18 @@
-# Contributing to the VotingWorks Ballot Marking Device
+# Contributing
 
-:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+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.
 
-We’re working on defining guidelines for contributing to this project.
+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.
 
-In the meantime, if you have questions/comments, please reach out to us:
-
-- [voting_works](https://twitter.com/voting_works/) on Twitter
-- Send us a message from our website: https://voting.works/
+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 [[email protected]](mailto:[email protected]) with any
+additional questions or comments.

README.md

@@ -1,4 +1,7 @@
-# ElectionGuard SDK Ballot Marking Device Reference Implementation
+![Microsoft Defending Democracy Program: ElectionGuard](images/electionguard-banner.svg)
+
+# 🗳 ElectionGuard Ballot Marking Device 
+[![license](https://img.shields.io/github/license/microsoft/electionguard-admin-device)](License)
 
 The ElectionGuard Reference Ballot Marking Device (BMD) is a fully functional
 implementation of a BMD built in ReactJS. It uses the
@@ -76,3 +79,7 @@ lint modern css. [Jest](https://jestjs.io/),
 [react-testing-library](https://github.com/kentcdodds/react-testing-library),
 and [Cypress](https://www.cypress.io/) are used to test components and
 end-to-end user flows.
+
+## Contributing
+
+Help defend democracy and [contribute to the project](CONTRIBUTING).