From 9179b0230e2de3c9577dbc15e90efc28040d301b Mon Sep 17 00:00:00 2001 From: ted chang Date: Thu, 29 Feb 2024 10:50:55 -0800 Subject: [PATCH] Add PR/Issue templates (#65) * Add PR template Signed-off-by: ted chang * Add Makefile Signed-off-by: ted chang * Update .github/ISSUE_TEMPLATE/user_story.md Co-authored-by: Sukriti Sharma Signed-off-by: ted chang * Update .github/pull_request_template.md Co-authored-by: Sukriti Sharma Signed-off-by: ted chang --------- Signed-off-by: ted chang Co-authored-by: Sukriti Sharma --- .github/ISSUE_TEMPLATE/bug_report.md | 34 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++++ .github/ISSUE_TEMPLATE/user_story.md | 23 +++++++++++++++ .github/pull_request_template.md | 19 +++++++++++++ Makefile | 14 ++++++++++ tox.ini | 1 + 6 files changed, 114 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/user_story.md create mode 100644 .github/pull_request_template.md create mode 100644 Makefile diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..7eeb55620 --- /dev/null +++ b/.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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 000000000..96b857215 --- /dev/null +++ b/.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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md new file mode 100644 index 000000000..4b62a291d --- /dev/null +++ b/.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 , I want to , so that I can + +## Discussion + +Provide detailed discussion here + +## Acceptance Criteria + + + +- [ ] Unit tests cover new/changed code +- [ ] Examples build against new/changed code +- [ ] READMEs are updated \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..467b55498 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,19 @@ + + +### Description of the change + + + +### Related issue number + + + +### How to verify the PR + + + +### Was the PR tested + + +- [ ] I have added >=1 unit test(s) for every new method I have added. +- [ ] I have ensured all unit tests pass \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..1541e8e6c --- /dev/null +++ b/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 \ No newline at end of file diff --git a/tox.ini b/tox.ini index bbcbba9b0..3ca14c330 100644 --- a/tox.ini +++ b/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