Skip to content

Commit d504c10

Browse files
authored
docs: update github templates (#47)
1 parent 0e23489 commit d504c10

11 files changed

+50
-66
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,33 @@
11
---
2-
name: Bug Report
3-
about: Unexpected or broken behavior of serverless-api-project
2+
name: 🐛 Bug Report
3+
about: Unexpected or broken behavior of the framework 🤔
44
labels: bug
55
---
66

77
<!--- Please keep this note for the community --->
88

99
### Community Note
1010

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
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
1414

1515
<!--- Thank you for keeping this note for the community --->
1616

17-
## What did you perfomed
1817

19-
<!-- e.g. create a simple get route -->
18+
### What did you do?
2019

21-
### Expected Behavior
20+
### What did you expect to see?
2221

23-
<!--- What should have happened? --->
22+
### What did you see instead?
2423

25-
### Actual Behavior
24+
### What version of Python are you using (`python --version`)?
2625

27-
<!--- What actually happened? --->
26+
```sh
27+
$ python --version
2828

29-
## More info
29+
# Optionnally, provide the version of your dependencies
30+
$ pip freeze
31+
```
3032

31-
<!-- verion of serverless-api-project used, your python version, your OS version, steps to reproduce, etc. -->
33+
### Does this issue reproduce with the latest release?

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
blank_issues_enabled: false
22
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 (#serverless-functions)"
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)

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: Feature request
2+
name: 🚀 Feature request
33
about: I have a suggestion (and might want to implement it myself 🙂)!
44
labels: enhancement
55
---
@@ -14,12 +14,11 @@ labels: enhancement
1414

1515
<!--- Thank you for keeping this note for the community --->
1616

17-
### Description
1817

19-
<!-- describe the problem that you think serverless-api-project might help you with -->
18+
### Proposal
2019

21-
### How I imagine scw could expose this functionality
20+
- **What is the proposed change?**
2221

23-
<!-- e.g. @app.resource -->
22+
- **Who does this proposal help, and why?**
2423

25-
### References
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

.github/dependabot.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
version: 2
22
updates:
33
- package-ecosystem: "github-actions"
4-
# Workflow files stored in the
5-
# default location of `.github/workflows`
4+
# Workflow files stored in the default location of `.github/workflows`
65
directory: "/"
76
schedule:
87
interval: "weekly"

.github/pull_request_template.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

.github/workflows/pytest-integration.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1+
---
12
name: Integration tests with Pytest
23

34
on:
45
push:
5-
branches: ["main"]
6+
branches: [main]
67
pull_request:
7-
branches: ["main"]
8+
branches: [main]
89

910
permissions:
1011
contents: read

.github/workflows/pytest.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1+
---
12
name: Pytest
23

34
on:
45
push:
5-
branches: ["main"]
6+
branches: [main]
67
pull_request:
7-
branches: ["main"]
8+
branches: [main]
89

910
permissions:
1011
contents: read

.github/workflows/python-publish.yml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,4 @@
1-
# This workflow will upload a Python Package using Twine when a release is created
2-
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
3-
4-
# This workflow uses actions that are not certified by GitHub.
5-
# They are provided by a third-party and are governed by
6-
# separate terms of service, privacy policy, and support
7-
# documentation.
8-
1+
---
92
name: Upload Python Package
103

114
on:

.pre-commit-config.yaml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
---
12
ci:
23
# Can't use a local installation of pylint with pre-commit.ci
34
skip: [pylint]
@@ -29,11 +30,7 @@ repos:
2930
entry: pylint
3031
language: system
3132
types: [python]
32-
args: [
33-
"-rn", # Only display messages
34-
"-sn", # Don't display the score
35-
"--rcfile=pyproject.toml",
36-
]
33+
args: [-rn, -sn, --rcfile=pyproject.toml]
3734
- repo: https://github.com/pycqa/flake8
3835
rev: 6.0.0
3936
hooks:
@@ -43,4 +40,4 @@ repos:
4340
rev: v1.0.6
4441
hooks:
4542
- id: python-bandit-vulnerability-check
46-
args: [--skip, "B101", --recursive, clumper]
43+
args: [--skip, B101, --recursive, clumper]

readthedocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ version: 2
33
build:
44
os: ubuntu-22.04
55
tools:
6-
python: "3.10"
6+
python: '3.10'
77
jobs:
88
post_install:
99
- pip install poetry==1.3.2

0 commit comments

Comments
 (0)