Skip to content

Commit a1b361d

Browse files
ml-ebs-extml-ebs-ext
committed
Pipeline updates. Linter exclusion.
1 parent de5df41 commit a1b361d

File tree

9 files changed

+191
-1
lines changed

9 files changed

+191
-1
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: 🐛 Bug Report
2+
description: "Report a reproducible bug in the project"
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
⚠️ **Reminder:** Everything you enter here will be publicly visible.
10+
Do not include any kind of sensitive data!
11+
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Description
16+
description: Clear and concise description of the bug
17+
placeholder: What went wrong?
18+
validations:
19+
required: false
20+
21+
- type: textarea
22+
id: steps
23+
attributes:
24+
label: Steps to Reproduce
25+
description: Step-by-step guide to reproduce the bug
26+
placeholder: |
27+
1. Go to...
28+
2. Run...
29+
3. See error
30+
validations:
31+
required: false
32+
33+
- type: input
34+
id: expected
35+
attributes:
36+
label: Expected Behavior
37+
description: What did you expect to happen?
38+
validations:
39+
required: false
40+
41+
- type: input
42+
id: environment
43+
attributes:
44+
label: Environment
45+
description: Browser and package version
46+
placeholder: e.g. Edge 1.0, dv.manager 2.0, dv.explorer.parameter 1.0

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
contact_links:
2+
- name: ⚠️ Reminder
3+
url: #
4+
about: Please note that all information shared in issues is public. Do not include sensitive data.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: ✨ Feature Request
2+
description: Suggest a new feature or improvement for the project
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
⚠️ **Reminder:** Everything you enter here will be publicly visible.
11+
Do not include any kind of sensitive data!
12+
- type: textarea
13+
id: problem
14+
attributes:
15+
label: Problem Statement
16+
description: What problem are you trying to solve? Why is it important?
17+
placeholder: It’s frustrating when...
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: solution
23+
attributes:
24+
label: Proposed Solution
25+
description: How would you like this feature to work?
26+
placeholder: I’d like to see...
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: alternatives
32+
attributes:
33+
label: Alternatives or Workarounds
34+
description: Have you tried other solutions? Why do they fall short?
35+
placeholder: Other ways I tried...
36+
validations:
37+
required: false
38+
39+
- type: textarea
40+
id: additional
41+
attributes:
42+
label: Additional Context
43+
description: Any extra details, screenshots, or examples?
44+
placeholder: Add any context or screenshots about the feature here.
45+
validations:
46+
required: false

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: ❓ Question / Support
2+
description: Ask a question or request help using the project
3+
title: "[Question]: "
4+
labels: ["question", "discussion"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
⚠️ **Reminder:** Everything you enter here will be publicly visible.
10+
Do not include any kind of sensitive data!
11+
- type: textarea
12+
id: context
13+
attributes:
14+
label: Your Question
15+
description: What would you like to know or clarify?
16+
placeholder: e.g. How do I configure X? Why does Y behave like this?
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: details
22+
attributes:
23+
label: Additional Context
24+
description: Provide logs, screenshots, or links if helpful

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Click the `Preview` tab and select a PR template:
2+
3+
- [PR with target `main`](?expand=1&template=main-pr.md)
4+
- [Regular PR usually to `test`](?expand=1&template=regular-test-pr.md)
5+
- [Hotfix PR usually to `test`](?expand=1&template=hotfix-test-pr.md)

‎.github/PULL_REQUEST_TEMPLATE/hotfix-test-pr.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Hotfix checklist
2+
3+
- [ ] Bumped minor version number on both DESCRIPTION and NEWS.md
4+
5+
- [ ] Build passes pipeline checks
6+
7+
- [ ] The new changes do not affect the API
8+
9+
- [ ] The new changes do not affect the documentation (including screenshots)
10+
11+
- [ ] The new changes do not impact the QC report
12+

‎.github/PULL_REQUEST_TEMPLATE/main-pr.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Stable Release
2+
- [ ] Update the version number and make sure -9000 suffix is removed.
3+
- [ ] Merge all NEWS under a single version entry
4+
- [ ] Integration tests pass
5+
- [ ] devtools::document() is up to date

‎.github/PULL_REQUEST_TEMPLATE/regular-test-pr.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Critical checks
2+
3+
- [ ] Is the test version number correct (x.x.x-9000)?
4+
5+
- [ ] DESCRIPTION file
6+
7+
- [ ] NEWS.md
8+
9+
- [ ] Does the build pass?
10+
11+
---
12+
13+
## Documentation
14+
15+
Does it include the following sections?
16+
17+
- [ ] Module introduction with features
18+
- [ ] (O) Screenshots
19+
20+
- [ ] Installation details
21+
22+
- [ ] Explanation of function arguments
23+
24+
- [ ] Data specifications and requirements
25+
26+
- [ ] Different possible visualizations
27+
28+
- [ ] Are the changes/new features included in NEWS.md?
29+
- [ ] (O) Screenshots
30+
31+
- [ ] (O) Explanation of input menus
32+
33+
- [ ] (O) Short articles on building the app, compatibility with other modules, known bugs,...
34+
35+
---
36+
37+
## QC Report
38+
39+
- [ ] Does it include a QC Report with positive outcome?
40+
41+
- [ ] Are the new features reflected accordingly in the specs?
42+
43+
---
44+
45+
## API conventions
46+
47+
- [ ] Follows API convention

‎.lintr.R‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ linters <- lintr::modify_defaults(
99
, object_length_linter = NULL # we don't type long var names just because
1010
, pipe_continuation_linter = NULL # wickham being overly prescriptive
1111
, trailing_blank_lines_linter = NULL # natural extension of trailing_whitespace_linter, present on the template
12+
, return_linter = NULL # wickham being overly prescriptive
1213
)
1314

1415
if(identical(Sys.getenv('CI'), "true")){
@@ -18,4 +19,4 @@ if(identical(Sys.getenv('CI'), "true")){
1819
) # We only disable this lint rule on github because it fails there because
1920
} # of a long-standing lintr bug
2021

21-
linters
22+
linters

0 commit comments

Comments
 (0)