Skip to content

docs: update github templates #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 15 additions & 13 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
---
name: Bug Report
about: Unexpected or broken behavior of serverless-api-project
name: 🐛 Bug Report
about: Unexpected or broken behavior of the framework 🤔
labels: bug
---

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

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

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

## What did you perfomed

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

### Expected Behavior
### What did you expect to see?

<!--- What should have happened? --->
### What did you see instead?

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

<!--- What actually happened? --->
```sh
$ python --version

## More info
# Optionnally, provide the version of your dependencies
$ pip freeze
```

<!-- verion of serverless-api-project used, your python version, your OS version, steps to reproduce, etc. -->
### Does this issue reproduce with the latest release?
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +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 (#serverless-functions)"
- 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)
11 changes: 5 additions & 6 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: Feature request
name: 🚀 Feature request
about: I have a suggestion (and might want to implement it myself 🙂)!
labels: enhancement
---
Expand All @@ -14,12 +14,11 @@ labels: enhancement

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

### Description

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

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

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

### References
### Example
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 1 addition & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
version: 2
updates:
- package-ecosystem: "github-actions"
# Workflow files stored in the
# default location of `.github/workflows`
# Workflow files stored in the default location of `.github/workflows`
directory: "/"
schedule:
interval: "weekly"
Expand Down
23 changes: 0 additions & 23 deletions .github/pull_request_template.md

This file was deleted.

5 changes: 3 additions & 2 deletions .github/workflows/pytest-integration.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
name: Integration tests with Pytest

on:
push:
branches: ["main"]
branches: [main]
pull_request:
branches: ["main"]
branches: [main]

permissions:
contents: read
Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/pytest.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
name: Pytest

on:
push:
branches: ["main"]
branches: [main]
pull_request:
branches: ["main"]
branches: [main]

permissions:
contents: read
Expand Down
9 changes: 1 addition & 8 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,4 @@
# This workflow will upload a Python Package using Twine when a release is created
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

---
name: Upload Python Package

on:
Expand Down
9 changes: 3 additions & 6 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
ci:
# Can't use a local installation of pylint with pre-commit.ci
skip: [pylint]
Expand Down Expand Up @@ -29,11 +30,7 @@ repos:
entry: pylint
language: system
types: [python]
args: [
"-rn", # Only display messages
"-sn", # Don't display the score
"--rcfile=pyproject.toml",
]
args: [-rn, -sn, --rcfile=pyproject.toml]
- repo: https://github.com/pycqa/flake8
rev: 6.0.0
hooks:
Expand All @@ -43,4 +40,4 @@ repos:
rev: v1.0.6
hooks:
- id: python-bandit-vulnerability-check
args: [--skip, "B101", --recursive, clumper]
args: [--skip, B101, --recursive, clumper]
2 changes: 1 addition & 1 deletion readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "3.10"
python: '3.10'
jobs:
post_install:
- pip install poetry==1.3.2
Expand Down