Skip to content

Commit 1712659

Browse files
committed
ci(config): Update config files
1 parent a98c0e8 commit 1712659

18 files changed

+161
-72
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# These are supported funding model platforms
22

33
patreon: guanguans
4-
custom: https://www.guanguans.cn/images/wechat.jpeg
4+
custom: https://guanguans.github.io/sponsors
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
name: Bug Report
2+
# https://github.com/spatie/package-skeleton-php/tree/main/.github/ISSUE_TEMPLATE
23
description: Report an Issue or Bug with the Package
34
title: "[Bug]: "
45
labels: [ "bug" ]
@@ -63,4 +64,4 @@ body:
6364
label: Notes
6465
description: Use this field to provide any other notes that you feel might be relevant to the issue.
6566
validations:
66-
required: false
67+
required: false

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
blank_issues_enabled: false
2+
# https://github.com/spatie/package-skeleton-php/tree/main/.github/ISSUE_TEMPLATE
23
contact_links:
34
- name: Ask a question
45
url: https://github.com/guanguans/soar-php/discussions/new?category=q-a
@@ -8,4 +9,4 @@ contact_links:
89
about: Share ideas for new features
910
- name: Report a security issue
1011
url: https://github.com/guanguans/soar-php/security/policy
11-
about: Learn how to notify us for sensitive bugs
12+
about: Learn how to notify us for sensitive bugs
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: 🚀 New feature proposal
2+
# https://github.com/antfu/.github/tree/main/.github/ISSUE_TEMPLATE
3+
description: Propose a new feature
4+
labels: [ enhancement ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for your interest in the project and taking the time to fill out this feature report!
10+
- type: textarea
11+
id: feature-description
12+
attributes:
13+
label: Clear and concise description of the problem
14+
description: 'As a developer using this project I want [goal / wish] so that [benefit]. If you intend to submit a PR for this issue, tell us in the description. Thanks!'
15+
validations:
16+
required: true
17+
- type: textarea
18+
id: suggested-solution
19+
attributes:
20+
label: Suggested solution
21+
description: 'In module [xy] we could provide following implementation...'
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: alternative
26+
attributes:
27+
label: Alternative
28+
description: Clear and concise description of any alternative solutions or features you've considered.
29+
- type: textarea
30+
id: additional-context
31+
attributes:
32+
label: Additional context
33+
description: Any other context or screenshots about the feature request here.
34+
- type: checkboxes
35+
id: checkboxes
36+
attributes:
37+
label: Validations
38+
description: Before submitting the issue, please make sure you do the following
39+
options:
40+
- label: Follow our [Code of Conduct](https://github.com/guanguans/soar-php/blob/master/.github/CODE_OF_CONDUCT.md)
41+
required: true
42+
- label: Read the [Contributing Guide](https://github.com/guanguans/soar-php/blob/master/.github/CONTRIBUTING.md).
43+
required: true
44+
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
45+
required: true

.github/ISSUE_TEMPLATE/typo.yml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: 👀 Typo / Grammar fix
2+
# https://github.com/antfu/.github/tree/main/.github/ISSUE_TEMPLATE
3+
description: You can just go ahead and send a PR! Thank you!
4+
labels: [ ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
## PR Welcome!
10+
11+
If the typo / grammar issue is trivial and straightforward, you can help by **directly sending a quick pull request**!
12+
If you spot multiple of them, we suggest combining them into a single PR. Thanks!
13+
- type: textarea
14+
id: context
15+
attributes:
16+
label: Additional context

.github/config.yml

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Configuration for todo - https://github.com/JasonEtco/todo
2+
todo:
3+
keyword: "@todo"
4+
5+
6+
7+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
8+
# Comment to be posted to on first time issues
9+
newIssueWelcomeComment: >
10+
Thanks for opening your first issue here! Be sure to follow the issue template!
11+
12+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
13+
# Comment to be posted to on PRs from first time contributors in your repository
14+
newPRWelcomeComment: >
15+
Thanks for opening this pull request! Please check out our contributing guidelines.
16+
17+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
18+
# Comment to be posted to on pull requests merged by a first time user
19+
firstPRMergeComment: >
20+
Congrats on merging your first pull request! We here at behaviorbot are proud of you!
21+
# It is recommend to include as many gifs and emojis as possible
22+
23+
24+
25+
# Configuration for request-info - https://github.com/behaviorbot/request-info
26+
# *OPTIONAL* Comment to reply with
27+
# Can be either a string :
28+
requestInfoReplyComment: >
29+
We would appreciate it if you could provide us with more info about this issue/pr!
30+
31+
# Or an array:
32+
# requestInfoReplyComment:
33+
# - Ah no! young blade! That was a trifle short!
34+
# - Tell me more !
35+
# - I am sure you can be more effusive
36+
37+
38+
# *OPTIONAL* default titles to check against for lack of descriptiveness
39+
# MUST BE ALL LOWERCASE
40+
requestInfoDefaultTitles:
41+
- update readme.md
42+
- updates
43+
44+
# *OPTIONAL* Label to be added to Issues and Pull Requests with insufficient information given
45+
requestInfoLabelToAdd: needs-more-info
46+
47+
# *OPTIONAL* Require Issues to contain more information than what is provided in the issue templates
48+
# Will fail if the issue's body is equal to a provided template
49+
checkIssueTemplate: true
50+
51+
# *OPTIONAL* Require Pull Requests to contain more information than what is provided in the PR template
52+
# Will fail if the pull request's body is equal to the provided template
53+
checkPullRequestTemplate: true
54+
55+
# *OPTIONAL* Only warn about insufficient information on these events type
56+
# Keys must be lowercase. Valid values are 'issue' and 'pullRequest'
57+
requestInfoOn:
58+
pullRequest: true
59+
issue: true
60+
61+
# *OPTIONAL* Add a list of people whose Issues/PRs will not be commented on
62+
# keys must be GitHub usernames
63+
requestInfoUserstoExclude:
64+
- guannguans
65+
66+
67+
# Configuration for update-docs - https://github.com/behaviorbot/update-docs
68+
# Comment to be posted to on PRs that don't update documentation
69+
updateDocsComment: >
70+
Thanks for opening this pull request! The maintainers of this repository would appreciate it if you would update some of our documentation based on your changes.
71+
72+
updateDocsWhiteList:
73+
- bug
74+
- chore
75+
76+
updateDocsTargetFiles:
77+
- README
78+
- docs/

.github/workflows/dependabot-auto-merge.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ jobs:
3232
run: gh pr merge --auto --merge "$PR_URL"
3333
env:
3434
PR_URL: ${{github.event.pull_request.html_url}}
35-
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
35+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/issues-translator.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ jobs:
1313
steps:
1414
- uses: usthe/issues-translate-action@v2.7
1515
with:
16-
IS_MODIFY_TITLE: true
16+
IS_MODIFY_TITLE: true

.github/workflows/label.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ jobs:
2222
steps:
2323
- uses: actions/labeler@v5
2424
with:
25-
repo-token: "${{ secrets.GITHUB_TOKEN }}"
25+
repo-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/lint-md.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ jobs:
1919
run: npm install -g @lint-md/cli
2020

2121
- name: Lint markdown
22-
run: lint-md --config .lintmdrc ./*.md ./.github/ ./docs/
22+
run: lint-md --config .lintmdrc --suppress-warnings *.md .github/ docs/

0 commit comments

Comments
 (0)