Skip to content

Commit 4e546dd

Browse files
epageepage
committed
chore: Align on boilerplate
1 parent dd97416 commit 4e546dd

17 files changed

+204
-214
lines changed

‎.github/FUNDING.yml

-1
This file was deleted.

‎.github/ISSUE_TEMPLATE.md

-45
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml

+4-24
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,21 @@
11
name: Bug report
2-
description: An issue with clap, clap_derive or clap_generate
2+
description: Things not quite working right
33
labels: 'T: bug'
44
body:
55
- type: checkboxes
66
attributes:
7-
label: Please complete the following tasks
87
options:
98
- label: I have searched the [discussions](https://github.com/clap-rs/clap/discussions)
10-
required: true
119
- label: I have searched the existing issues
12-
required: true
13-
- type: input
10+
- type: textarea
1411
attributes:
15-
label: Rust Version
16-
description: Output of `rustc -V`
12+
label: Description
1713
validations:
1814
required: true
1915
- type: input
2016
attributes:
21-
label: Clap Version
17+
label: Version
2218
description: Can be found in Cargo.lock or Cargo.toml of your project (i.e. `grep clap Cargo.lock`). PLEASE DO NOT PUT "latest" HERE, use precise version. Put `master` (or other branch) if you're using the repo directly.
23-
validations:
24-
required: true
2519
- type: textarea
2620
attributes:
2721
label: Minimal reproducible code
@@ -32,28 +26,14 @@ body:
3226
```
3327
validations:
3428
required: true
35-
- type: textarea
36-
attributes:
37-
label: Steps to reproduce the bug with the above code
38-
description: A command like `cargo run -- options...` or multiple commands.
39-
validations:
40-
required: true
4129
- type: textarea
4230
attributes:
4331
label: Actual Behaviour
4432
description: When I do like *this*, *that* is happening and I think it shouldn't.
45-
validations:
46-
required: true
4733
- type: textarea
4834
attributes:
4935
label: Expected Behaviour
5036
description: I think *this* should happen instead.
51-
validations:
52-
required: true
53-
- type: textarea
54-
attributes:
55-
label: Additional Context
56-
description: Add any other context about the problem here.
5737
- type: textarea
5838
attributes:
5939
label: Debug Output

‎.github/ISSUE_TEMPLATE/config.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
blank_issues_enabled: true
22
contact_links:
33
- name: Ask a question
4-
about: You've come to seek help or want to discuss something related to clap
4+
about: For support or brainstorming
55
url: https://github.com/clap-rs/clap/discussions/new
6-
# TODO: Question template (waiting for discussions template feature)

‎.github/ISSUE_TEMPLATE/documentation_issue.yml

-34
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml

+7-20
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,22 @@ labels: 'T: new feature'
44
body:
55
- type: checkboxes
66
attributes:
7-
label: Please complete the following tasks
87
options:
98
- label: I have searched the [discussions](https://github.com/clap-rs/clap/discussions)
10-
required: true
119
- label: I have searched the existing issues
12-
required: true
1310
- type: input
1411
attributes:
15-
label: Clap Version
12+
label: Version
1613
description: Can be found in Cargo.lock or Cargo.toml of your project (i.e. `grep clap Cargo.lock`). PLEASE DO NOT PUT "latest" HERE, use precise version. Put `master` (or other branch) if you're using the repo directly.
17-
validations:
18-
required: true
1914
- type: textarea
2015
attributes:
21-
label: Describe your use case
22-
description: Describe the problem you're trying to solve. This is not mandatory and we *do* consider features without a specific use case, but real problems have priority.
23-
validations:
24-
required: true
16+
label: Use Case
17+
description: Describe the problem you're trying to solve.
2518
- type: textarea
2619
attributes:
27-
label: Describe the solution you'd like
28-
description: Please explain what the wanted solution should look like. You are **strongly encouraged** to attach a snippet of (pseudo)code.
29-
validations:
30-
required: true
20+
label: Requirements
21+
description: Describe what is needed to satisfy your use case.
3122
- type: textarea
3223
attributes:
33-
label: Alternatives, if applicable
34-
description: A clear and concise description of any alternative solutions or features you've managed to come up with.
35-
- type: textarea
36-
attributes:
37-
label: Additional Context
38-
description: Add any other context about the feature request here.
24+
label: Possible Solutions
25+
description: A clear and concise description of any solutions or features you've managed to come up with.

‎.github/PULL_REQUEST_TEMPLATE.md

-5
This file was deleted.

‎.github/dependabot.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: cargo
4+
directory: "/"
5+
schedule:
6+
interval: monthly
7+
time: "07:00"
8+
open-pull-requests-limit: 10

‎.github/settings.yml

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# These settings are synced to GitHub by https://probot.github.io/apps/settings/
2+
3+
repository:
4+
description: A full featured, fast Command Line Argument Parser for Rust
5+
homepage: docs.rs/clap
6+
topics: rust cli command-line argparse clap
7+
has_issues: true
8+
has_projects: false
9+
has_wiki: false
10+
has_downloads: true
11+
default_branch: main
12+
13+
allow_squash_merge: true
14+
allow_merge_commit: true
15+
allow_rebase_merge: true
16+
17+
# Manual: allow_auto_merge: true, see https://github.com/probot/settings/issues/402
18+
delete_branch_on_merge: true
19+
20+
labels:
21+
# Type
22+
- name: bug
23+
color: '#b60205'
24+
description: Not as expected
25+
- name: enhancement
26+
color: '#1d76db'
27+
description: Improve the expected
28+
# Flavor
29+
- name: question
30+
color: "#cc317c"
31+
description: Uncertainty is involved
32+
- name: breaking-change
33+
color: "#e99695"
34+
- name: good first issue
35+
color: '#c2e0c6'
36+
description: Help wanted!
37+
38+
branches:
39+
- name: main
40+
protection:
41+
required_pull_request_reviews: null
42+
required_conversation_resolution: true
43+
required_status_checks:
44+
# Required. Require branches to be up to date before merging.
45+
strict: false
46+
contexts: ["CI", "Lint Commits", "Spell Check with Typos"]
47+
enforce_admins: false
48+
restrictions: null

‎.github/workflows/audit.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Security audit
2+
on:
3+
pull_request:
4+
paths:
5+
- '**/Cargo.toml'
6+
- '**/Cargo.lock'
7+
push:
8+
paths:
9+
- '**/Cargo.toml'
10+
- '**/Cargo.lock'
11+
schedule:
12+
- cron: '3 3 3 * *'
13+
jobs:
14+
security_audit:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout repository
18+
uses: actions/checkout@v2
19+
- uses: actions-rs/audit-check@v1
20+
with:
21+
token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/committed.yml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Lint Commits
2+
on: [pull_request]
3+
4+
jobs:
5+
committed:
6+
name: Lint Commits
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout Actions Repository
10+
uses: actions/checkout@v2
11+
with:
12+
fetch-depth: 0
13+
- name: Lint Commits
14+
uses: crate-ci/committed@master

‎.github/workflows/pre-commit.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: pre-commit
2+
on:
3+
pull_request:
4+
push:
5+
branches: [source]
6+
jobs:
7+
pre-commit:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- uses: actions/checkout@v2
11+
- uses: actions/setup-python@v2
12+
- uses: pre-commit/[email protected]

‎.github/workflows/spelling.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Spelling
2+
on: [pull_request]
3+
4+
jobs:
5+
spelling:
6+
name: Spell Check with Typos
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Checkout Actions Repository
10+
uses: actions/checkout@v2
11+
- name: Spell Check Repo
12+
uses: crate-ci/typos@master

‎.gitignore

+1-34
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,2 @@
1-
# Compiled files
2-
*.o
3-
*.so
4-
*.rlib
5-
*.dll
6-
7-
# Executables
8-
*.exe
9-
10-
# Generated by Cargo
11-
target/
12-
13-
# Cargo files
1+
target
142
Cargo.lock
15-
16-
# Temp files
17-
.*~
18-
19-
# Backup files
20-
*.bak
21-
*.bk
22-
*.orig
23-
24-
# Project files
25-
.vscode/*
26-
.idea/*
27-
clap-rs.iml
28-
29-
# Auxiliary files
30-
test-results.test
31-
expanded.rs
32-
clap_derive/expanded.rs
33-
34-
# ctags
35-
**/*.vi

‎.pre-commit-config.yaml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v2.3.0
4+
hooks:
5+
- id: check-yaml
6+
stages: [commit]
7+
- id: check-json
8+
stages: [commit]
9+
- id: check-toml
10+
stages: [commit]
11+
- id: check-merge-conflict
12+
stages: [commit]
13+
- id: check-case-conflict
14+
stages: [commit]
15+
- id: detect-private-key
16+
stages: [commit]
17+
- repo: https://github.com/crate-ci/committed
18+
rev: v0.2.5
19+
hooks:
20+
- id: committed
21+
stages: [commit-msg]

0 commit comments

Comments
 (0)