Skip to content

Commit

Permalink
ci: add GitHub templates + GitPod extensions (#6)
Browse files Browse the repository at this point in the history
* ci: upgrade developer dependencies
* ci: fix markdown-link-check quot pattern
* ci: add GitHub issue templates

Co-authored-by: GitHub <[email protected]>
  • Loading branch information
redeboer and web-flow authored Apr 26, 2021
1 parent 371b43a commit 06576f3
Show file tree
Hide file tree
Showing 8 changed files with 86 additions and 3 deletions.
4 changes: 3 additions & 1 deletion .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
],
"language": "en-US",
"words": [
"conda",
"pdgref",
"pylint",
"pytest"
Expand All @@ -65,6 +66,7 @@
"pyquery",
"rtfd",
"setuptools",
"sphinxcontrib"
"sphinxcontrib",
"venv"
]
}
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: Bug
assignees: ""
---

## Bug description

<!-- A clear and concise description of what the bug is. -->

<!-- If applicable, add a log or screenshot to help explain your problem. -->

## How to reproduce?

Steps to reproduce the behavior:

1.

## Expected behavior

<!-- A clear and concise description of what you expected to happen. -->

## System info

Bug resulted on the following system:

- OS: <!-- e.g. macOS, WSL Ubuntu, ...-->
- Version <!-- e.g. 10.15, 20.04, ... -->
- Python version: <!-- e.g. 3.6, 3.7, ... -->
- Virtual environment: <!-- e.g. venv, Conda, pip user install, ... -->
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an idea for this project
title: ""
labels: "💡 Enhancement"
assignees: ""
---

## Problem description

<!-- Is your feature request related to a problem? Please provide a clear and
concise description of what the problem is. [Example: "I'm always frustrated
when ..." -->

## Proposed solution

<!-- Describe the solution you'd want to happen. -->

<!-- Are there alternatives you have considered? -->

<!-- Additional context: -->
<!-- Add any other context or screenshots about the feature -->
5 changes: 5 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<!-- Fixes #xxx -->

<!-- For the PR title, follow a conventional commit message style: https://pwa.readthedocs.io/develop.html#commit-conventions -->

<!-- Contents of this PR appear in the release notes. Please use screenshots, code snippets etc. to illustrate proposed changes -->
18 changes: 18 additions & 0 deletions .gitpod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,21 @@ github:
addComment: false
addBadge: false
addLabel: false

vscode:
extensions:
- bungcip.better-toml
- christian-kohler.path-intellisense
- davidanson.vscode-markdownlint
- eamodio.gitlens
- editorconfig.editorconfig
- esbenp.prettier-vscode
- ms-python.python
- ms-python.vscode-pylance
- redhat.vscode-yaml
- ryanluker.vscode-coverage-gutters
- stkb.rewrap
- streetsidesoftware.code-spell-checker
- travisillig.vscode-json-stable-stringify
- tyriar.sort-lines
- yzhang.markdown-all-in-one
3 changes: 3 additions & 0 deletions .markdown-link-check.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
"ignorePatterns": [
{
"pattern": "\\{\\d+\\}"
},
{
"pattern": ".*&quot;"
}
]
}
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ repos:
- id: trailing-whitespace

- repo: https://github.com/ComPWA/repo-maintenance
rev: 0.0.12
rev: 0.0.14
hooks:
- id: check-dev-files

Expand Down Expand Up @@ -73,7 +73,7 @@ repos:
language_version: 12.18.2 # prettier does not specify node correctly

- repo: https://github.com/ComPWA/mirrors-pyright
rev: v1.1.132
rev: v1.1.134
hooks:
- id: pyright

Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
[![PyPI package](https://badge.fury.io/py/sphinxcontrib-hep-pdgref.svg)](https://pypi.org/project/sphinxcontrib-hep-pdgref)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/sphinxcontrib-hep-pdgref)](https://pypi.org/project/sphinxcontrib-hep-pdgref)
[![GPLv3+ license](https://img.shields.io/badge/License-GPLv3+-blue.svg)](https://www.gnu.org/licenses/gpl-3.0-standalone.html)
[![GitPod](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/sphinxcontrib-hep-pdgref)
[![Test coverage](https://codecov.io/gh/ComPWA/sphinxcontrib-hep-pdgref/branch/main/graph/badge.svg?token=SS8ZB8J11N)](https://codecov.io/gh/ComPWA/sphinxcontrib-hep-pdgref)
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/dbe042deb2914f6098eb98586d3983fe)](https://www.codacy.com/gh/ComPWA/sphinxcontrib-hep-pdgref)
[![CI status](https://github.com/ComPWA/sphinxcontrib-hep-pdgref/workflows/CI-tests/badge.svg)](https://github.com/ComPWA/sphinxcontrib-hep-pdgref/actions?query=branch%3Amain+workflow%3ACI-tests)
Expand Down

0 comments on commit 06576f3

Please sign in to comment.