Skip to content

Commit bea6f89

Browse files
authored
Merge pull request #221 from adafruit/help-text-and-pr-template
Added help text and pr template patches
2 parents 41b2432 + b83f578 commit bea6f89

File tree

2 files changed

+78
-0
lines changed

2 files changed

+78
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
From 3860976e511f1407840c914a8c550ac154716cf9 Mon Sep 17 00:00:00 2001
2+
From: dherrada <[email protected]>
3+
Date: Wed, 19 May 2021 13:35:18 -0400
4+
Subject: [PATCH] Added help text and problem matcher
5+
6+
---
7+
.github/workflows/build.yml | 2 ++
8+
.github/workflows/failure-help-text.yml | 19 +++++++++++++++++++
9+
2 files changed, 21 insertions(+)
10+
create mode 100644 .github/workflows/failure-help-text.yml
11+
12+
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
13+
index 3baf502..ce66461 100644
14+
--- a/.github/workflows/build.yml
15+
+++ b/.github/workflows/build.yml
16+
@@ -49,0 +50,2 @@ jobs:
17+
+ - name: Setup problem matchers
18+
+ uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1
19+
diff --git a/.github/workflows/failure-help-text.yml b/.github/workflows/failure-help-text.yml
20+
new file mode 100644
21+
index 0000000..0b1194f
22+
--- /dev/null
23+
+++ b/.github/workflows/failure-help-text.yml
24+
@@ -0,0 +1,19 @@
25+
+# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries
26+
+#
27+
+# SPDX-License-Identifier: MIT
28+
+
29+
+name: Failure help text
30+
+
31+
+on:
32+
+ workflow_run:
33+
+ workflows: ["Build CI"]
34+
+ types:
35+
+ - completed
36+
+
37+
+jobs:
38+
+ post-help:
39+
+ runs-on: ubuntu-latest
40+
+ if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }}
41+
+ steps:
42+
+ - name: Post comment to help
43+
+ uses: adafruit/circuitpython-action-library-ci-failed@v1
44+
--
45+
2.25.1
46+
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
From 763698dd1677b2ef3e2d269767368589bf416c06 Mon Sep 17 00:00:00 2001
2+
From: dherrada <[email protected]>
3+
Date: Wed, 19 May 2021 13:32:42 -0400
4+
Subject: [PATCH] Added pull request template
5+
6+
---
7+
.../adafruit_circuitpython_pr.md | 13 +++++++++++++
8+
1 file changed, 13 insertions(+)
9+
create mode 100644 .github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
10+
11+
diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
12+
new file mode 100644
13+
index 0000000..71ef8f8
14+
--- /dev/null
15+
+++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
16+
@@ -0,0 +1,13 @@
17+
+# SPDX-FileCopyrightText: 2021 Adafruit Industries
18+
+#
19+
+# SPDX-License-Identifier: MIT
20+
+
21+
+Thank you for contributing! Before you submit a pull request, please read the following.
22+
+
23+
+Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html
24+
+
25+
+If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs
26+
+
27+
+Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code
28+
+
29+
+Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues.
30+
--
31+
2.25.1
32+

0 commit comments

Comments
 (0)