Skip to content

Commit 70e4204

Browse files
authored
docs: add github templates (#5)
* docs: add github templates * docs: update bug report * docs: fix stale naming in readme
1 parent b239151 commit 70e4204

File tree

5 files changed

+79
-2
lines changed

5 files changed

+79
-2
lines changed
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Unexpected or broken behavior of the framework 🤔
4+
labels: bug
5+
---
6+
7+
<!--- Please keep this note for the community --->
8+
9+
### Community Note
10+
11+
- 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
12+
- 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
13+
- If you are interested in working on this issue or have submitted a pull request, please leave a comment
14+
15+
<!--- Thank you for keeping this note for the community --->
16+
17+
18+
### What did you do?
19+
20+
### What did you expect to see?
21+
22+
### What did you see instead?
23+
24+
### What version of Python are you using (`python --version`)?
25+
26+
```sh
27+
$ python --version
28+
29+
# Optionnally, provide the version of your dependencies
30+
$ pip freeze
31+
```
32+
33+
### Does this issue reproduce with the latest release?

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Scaleway Community
4+
url: https://slack.scaleway.com
5+
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)
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 🚀 Feature request
3+
about: I have a suggestion (and might want to implement it myself 🙂)!
4+
labels: enhancement
5+
---
6+
7+
<!--- Please keep this note for the community --->
8+
9+
### Community Note
10+
11+
* 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
12+
* 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
13+
* If you are interested in working on this issue or have submitted a pull request, please leave a comment
14+
15+
<!--- Thank you for keeping this note for the community --->
16+
17+
18+
### Proposal
19+
20+
- **What is the proposed change?**
21+
22+
- **Who does this proposal help, and why?**
23+
24+
### Example

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Summary
2+
3+
**_What's changed?_**
4+
5+
**_Why do we need this?_**
6+
7+
**_How have you tested it?_**
8+
9+
## Checklist
10+
11+
- [ ] I have reviewed this myself
12+
- [ ] There is a unit test covering every change in this PR
13+
- [ ] I have updated the relevant documentation
14+
15+
## Details

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ def handler(event, context):
2222
if __name__ == "__main__":
2323
# The import is conditional so that you do not need
2424
# to package the library when deploying on Scaleway Functions.
25-
from scaleway_functions_python import serve_handler_locally
26-
serve_handler_locally(handler, port=8080)
25+
from scaleway_functions_python import local
26+
local.serve_handler(handler, port=8080)
2727
```
2828

2929
You can then run your function locally:

0 commit comments

Comments
 (0)