Add PR/Issue templates (#65)

* Add PR template

Signed-off-by: ted chang <[email protected]>

* Add Makefile

Signed-off-by: ted chang <[email protected]>

* Update .github/ISSUE_TEMPLATE/user_story.md

Co-authored-by: Sukriti Sharma <[email protected]>
Signed-off-by: ted chang <[email protected]>

* Update .github/pull_request_template.md

Co-authored-by: Sukriti Sharma <[email protected]>
Signed-off-by: ted chang <[email protected]>

---------

Signed-off-by: ted chang <[email protected]>
Co-authored-by: Sukriti Sharma <[email protected]>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ""
+labels: ""
+assignees: ""
+---
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+## Platform
+
+Please provide details about the environment you are using, including the following:
+
+- Interpreter version:
+- Library version:
+
+## Sample Code
+
+Please include a minimal sample of the code that will (if possible) reproduce the bug in isolation
+
+## Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+## Observed behavior
+
+What you see happening (error messages, stack traces, etc...)
+
+## Additional context
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ""
+labels: ""
+assignees: ""
+---
+
+## Is your feature request related to a problem? Please describe.
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+## Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considered
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+
+Add any other context about the feature request here.

.github/ISSUE_TEMPLATE/user_story.md

@@ -0,0 +1,23 @@
+---
+name: User story
+about: A user-oriented story describing a piece of work to do
+title: ""
+labels: ""
+assignees: ""
+---
+
+## Description
+
+As a <user type>, I want to <do something>, so that I can <accomplish something>
+
+## Discussion
+
+Provide detailed discussion here
+
+## Acceptance Criteria
+
+<!-- Remove any that don't apply -->
+
+- [ ] Unit tests cover new/changed code
+- [ ] Examples build against new/changed code
+- [ ] READMEs are updated

.github/pull_request_template.md

@@ -0,0 +1,19 @@
+<!-- Thank you for the contribution! -->
+
+### Description of the change
+
+<!-- Please summarize the changes -->
+
+### Related issue number
+
+<!-- For example: "Closes #1234" -->
+
+### How to verify the PR
+
+<!-- Please provide instruction or screenshots on how to verify the PR.-->
+
+### Was the PR tested
+
+<!-- Describe how PR was tested -->
+- [ ] I have added >=1 unit test(s) for every new method I have added.
+- [ ] I have ensured all unit tests pass

Makefile

@@ -0,0 +1,14 @@
+# Run unit tests
+.PHONY: test
+test: fmt lint
+	tox -e py
+
+# Format python code
+.PHONY: fmt
+fmt:
+	tox -e fmt
+
+# Run pylint to check code
+..PHONY: lint
+lint:
+	tox -e lint

tox.ini

@@ -8,5 +8,6 @@ allowlist_externals = ./scripts/fmt.sh
 
 [testenv:lint]
 description = lint with pylint
+deps = pylint>=2.16.2,<=3.1.0
 commands = pylint tuning scripts/*.py
 allowlist_externals = pylint