From c905be52b48b5e0b741448cbd73844e865636a18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andy=20M=C3=A9ry?= Date: Thu, 2 Mar 2023 09:42:42 +0100 Subject: [PATCH 1/3] docs: add github templates --- .github/ISSUE_TEMPLATE/bug_report.md | 30 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++++ .github/ISSUE_TEMPLATE/feature_request.md | 24 ++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 15 ++++++++++++ 4 files changed, 74 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..f721e7c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: 🐛 Bug Report +about: Unexpected or broken behavior of the framework 🤔 +labels: bug +--- + + + +### Community Note + +- Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request +- Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request +- If you are interested in working on this issue or have submitted a pull request, please leave a comment + + + + +### What did you do? + +### What did you expect to see? + +### What did you see instead? + +### What version of Go are you using (`go version`)? + +```sh +$ go version +``` + +### Does this issue reproduce with the latest release? diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..c7f352d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Scaleway Community + url: https://slack.scaleway.com + about: GitHub issues in this repository are only intended for bug reports and feature requests. Other issues will be closed. Please ask questions on the Scaleway Community Slack (#opensource) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..d3d61fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +name: 🚀 Feature request +about: I have a suggestion (and might want to implement it myself 🙂)! +labels: enhancement +--- + + + +### Community Note + +* Please vote on this issue by adding a 👍 [reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to the original issue to help the community and maintainers prioritize this request +* Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request +* If you are interested in working on this issue or have submitted a pull request, please leave a comment + + + + +### Proposal + +- **What is the proposed change?** + +- **Who does this proposal help, and why?** + +### Example diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c05500c --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,15 @@ +## Summary + +**_What's changed?_** + +**_Why do we need this?_** + +**_How have you tested it?_** + +## Checklist + +- [ ] I have reviewed this myself +- [ ] There is a unit test covering every change in this PR +- [ ] I have updated the relevant documentation + +## Details From 4cd6711da85fe3eee2d33588506ef815134e43cb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andy=20M=C3=A9ry?= Date: Thu, 2 Mar 2023 09:53:18 +0100 Subject: [PATCH 2/3] docs: update bug report --- .github/ISSUE_TEMPLATE/bug_report.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f721e7c..8546c27 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -21,10 +21,13 @@ labels: bug ### What did you see instead? -### What version of Go are you using (`go version`)? +### What version of Python are you using (`python --version`)? ```sh -$ go version +$ python --version + +# Optionnally, provide the version of your dependencies +$ pip freeze ``` ### Does this issue reproduce with the latest release? From 13d36552e29baf7b8a18f90faf018af579bd405f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andy=20M=C3=A9ry?= Date: Thu, 2 Mar 2023 10:52:42 +0100 Subject: [PATCH 3/3] docs: fix stale naming in readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4a6c93a..d6a2801 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,8 @@ def handler(event, context): if __name__ == "__main__": # The import is conditional so that you do not need # to package the library when deploying on Scaleway Functions. - from scaleway_functions_python import serve_handler_locally - serve_handler_locally(handler, port=8080) + from scaleway_functions_python import local + local.serve_handler(handler, port=8080) ``` You can then run your function locally: