Skip to content

Commit ddbf864

Browse files
authored
Merge branch 'main' into meta-rfc
2 parents 45365e5 + 8c511be commit ddbf864

File tree

8 files changed

+84
-31
lines changed

8 files changed

+84
-31
lines changed

.editorconfig

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
indent_size = 4
9+
indent_style = space
10+
11+
[*.{md,yml,yaml,html,css,scss,js,cff}]
12+
indent_size = 2

.github/ISSUE_TEMPLATE/new_pipeline.yml

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,37 @@ title: "New pipeline: nf-core/<add provisional pipeline name here>"
44
labels: "new-pipeline,proposed"
55
projects: nf-core/104
66
body:
7-
87
- type: input
98
attributes:
109
label: Pipeline title/name
1110
description: Names should be [lower case, without punctuation, and descriptive](https://nf-co.re/docs/guidelines/pipelines/requirements/workflow_name) (not 'fun' names).
1211
placeholder: rnaseq
1312
validations:
14-
required: true
13+
required: true
1514

1615
- type: input
1716
attributes:
1817
label: Keywords
1918
description: Provide a comma separated list of useful keywords for data type/analysis type/research field of the proposal (e.g. genomics, cancer, variant calling).
2019
placeholder: genomics, cancer, variant calling
2120
validations:
22-
required: true
21+
required: true
2322

2423
- type: textarea
2524
attributes:
2625
label: What is it about?
2726
description: Give a short summary of the purpose of the pipeline.
28-
placeholder: An RNA sequencing analysis pipeline using STAR, RSEM, HISAT2 or Salmon with gene/isoform counts and extensive quality control.
27+
placeholder: An RNA sequencing analysis pipeline using STAR, RSEM, HISAT2 or Salmon with gene/isoform counts and extensive quality control.
2928
validations:
30-
required: true
29+
required: true
3130

3231
- type: textarea
3332
attributes:
3433
label: Please provide a schematic diagram of the proposed pipeline
3534
description: Please use tool names as each 'node'. Drag and drop the image file into the text area to upload.
36-
placeholder: ![](https://your.url/image/png)
35+
placeholder: "![](https://your.url/image/png)"
3736
validations:
38-
required: true
37+
required: true
3938

4039
- type: checkboxes
4140
attributes:
@@ -66,23 +65,23 @@ body:
6665
label: Why do we need a new pipeline?
6766
description: Describe the 'usefuless' or 'novelty' of the pipeline whether analytically or within nf-core.
6867
validations:
69-
required: true
68+
required: true
7069

7170
- type: textarea
7271
attributes:
7372
label: Who would be interested?
7473
description: Please give possible target audiences of the pipelines.
7574
placeholder: Researchers working on transcriptomics.
7675
validations:
77-
required: true
76+
required: true
7877

7978
- type: textarea
8079
attributes:
8180
label: What has been done so far
8281
description: Please describe the current status of the concept or code, or say if you have not stated.
8382
placeholder: I have started making nf-core modules for tools I would use in the proposed pipeline.
8483
validations:
85-
required: true
84+
required: true
8685

8786
- type: input
8887
attributes:

.github/ISSUE_TEMPLATE/new_rfc.yml

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,40 +11,39 @@ body:
1111
label: Summary
1212
description: Short 2-3 sentence summary of RFC proposal.
1313
validations:
14-
required: true
14+
required: true
1515
- type: input
1616
attributes:
1717
label: Champion
1818
description: "GitHub handle of the proposal's champion (if already found)."
19-
placeholder:
20-
e.g. @maxulysse
19+
placeholder: e.g. @maxulysse
2120
- type: textarea
2221
attributes:
2322
label: Background & Motivation
2423
description: Provide the context of the proposal, summarising the existing status-quo or issues.
25-
placeholder:
24+
placeholder:
2625
validations:
27-
required: true
26+
required: true
2827
- type: textarea
2928
attributes:
3029
label: Goals
31-
description: Provide a 2-3 bullet point list of the main aims and objectives the outcome RFC aims to achieve
30+
description: Provide a 2-3 bullet point list of the main aims and objectives the outcome RFC aims to achieve
3231
placeholder: |
3332
- Goal 1
3433
- Goal 2
3534
- Goal 3
3635
validations:
37-
required: true
36+
required: true
3837
- type: textarea
3938
attributes:
4039
label: "Non-Goals"
41-
description: Provide a 2-3 bullet point list of the main aims and objectives the outcome RFC aims NOT to achieve.
40+
description: Provide a 2-3 bullet point list of the main aims and objectives the outcome RFC aims NOT to achieve.
4241
placeholder: |
4342
- Non-goal 1
4443
- Non-goal 2
4544
- Non-goal 3
4645
validations:
47-
required: false
46+
required: false
4847
- type: textarea
4948
attributes:
5049
label: References
@@ -54,4 +53,4 @@ body:
5453
- Original GitHub Issue - https://github.com/nf-core/<URL>
5554
- Prototype - https://github.com/nf-core/<URL>
5655
validations:
57-
required: false
56+
required: false

.github/ISSUE_TEMPLATE/new_special_interest_group.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,36 +18,36 @@ body:
1818
description: Suggested interest group name. It should be as simple, descriptive and boring as possible.
1919
placeholder: Animal Genomics
2020
validations:
21-
required: true
21+
required: true
2222

2323
- type: textarea
2424
attributes:
2525
label: What is it about?
2626
description: Give a one sentence description of the purpose of the special interest group.
2727
validations:
28-
required: true
28+
required: true
2929

3030
- type: input
3131
attributes:
3232
label: Keywords
3333
description: Provide a comma separated list of useful keywords for topics related to the proposal (e.g. genomics, cancer, variant calling).
3434
placeholder: genomics, cancer, variant calling
3535
validations:
36-
required: true
36+
required: true
3737

3838
- type: textarea
3939
attributes:
4040
label: Why do we need a new special interest group?
4141
description: Describe the 'usefuless' or 'novelty' of the special interest group within nf-core.
4242
validations:
43-
required: true
43+
required: true
4444

4545
- type: textarea
4646
attributes:
4747
label: Who would be interested?
4848
description: Please give possible target audiences of the special interest groups.
4949
validations:
50-
required: true
50+
required: true
5151

5252
- type: textarea
5353
attributes:

.github/workflows/pre-commit.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Lint tools code formatting
2+
on:
3+
push:
4+
pull_request:
5+
6+
# Cancel if a newer run is started
7+
concurrency:
8+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
9+
cancel-in-progress: true
10+
11+
jobs:
12+
Pre-commit:
13+
runs-on: ubuntu-latest
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
16+
steps:
17+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
18+
19+
- name: Set up Python 3.12
20+
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
21+
with:
22+
python-version: "3.12"
23+
cache: "pip"
24+
25+
- name: Install pre-commit
26+
run: pip install pre-commit
27+
28+
- name: Run pre-commit
29+
run: pre-commit run --all-files

.pre-commit-config.yaml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/mirrors-prettier
3+
rev: "v3.1.0"
4+
hooks:
5+
- id: prettier
6+
additional_dependencies:
7+
8+
9+
- repo: https://github.com/editorconfig-checker/editorconfig-checker.python
10+
rev: "3.1.2"
11+
hooks:
12+
- id: editorconfig-checker
13+
alias: ec

.prettierrc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
printWidth: 120

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ To make a new proposal for a special interest group, please create a new issue i
2323

2424
The curator workflow is as follows:
2525

26-
- [ ] Once a issue is made, update the 'Project' status to 'proposed' (right hand side bar, under 'new-<TYPE>-proposals')
26+
- [ ] Once a issue is made, update the 'Project' status to 'proposed' (right hand side bar, under 'new-<TYPE>-proposals')
2727
- [ ] Facilitate discussion on the the Issue thread, following the guidance [here](https://nf-co.re/docs/checklists/community_governance/core_team#new-pipeline-proposals-and-onboarding).
2828
- [ ] Acceptance requires a minimum of OKs from:
29-
- Two members of the core team.
30-
- One member of the core team and one member of the maintainers team.
29+
- Two members of the core team.
30+
- One member of the core team and one member of the maintainers team.
3131
- [ ] If a proposal is accepted, update both the label AND status to 'accepted', and when closing select 'Close as completed'
32-
- [ ] If a proposal is turned down, update both the label AND status to 'turned-down', and when closing select 'Close as not planned'
32+
- [ ] If a proposal is turned down, update both the label AND status to 'turned-down', and when closing select 'Close as not planned'
3333
- [ ] If a proposal is not completed or abandoned after a year, update both the label AND status to 'timed-out', and when closing select 'Close as not planned'
3434
- [ ] Complete the reemaining new-pipeline onboarding tasks listed [here](https://nf-co.re/docs/checklists/community_governance/core_team#new-pipeline-proposals-and-onboarding)
3535

@@ -40,7 +40,7 @@ The curator workflow is as follows:
4040
- [ ] Once a issue is made, update the 'Project' status to 'proposed' (right hand side bar, under 'new-<TYPE>-proposals')
4141
- [ ] Facilitate discussion on the the Issue thread, following the guidance [here](https://nf-co.re/blog/2024/special_interest_groups).
4242
- [ ] Acceptance requires a minimum of OKs from:
43-
- Two members of the core team.
43+
- Two members of the core team.
4444
- [ ] If a proposal is accepted, update both the label AND status to 'accepted', and when closing select 'Close as completed'
45-
- [ ] If a proposal is turned down, update both the label AND status to 'turned-down', and when closing select 'Close as not planned'
45+
- [ ] If a proposal is turned down, update both the label AND status to 'turned-down', and when closing select 'Close as not planned'
4646
- [ ] If a proposal is not completed or abandoned after a year, update both the label AND status to 'timed-out', and when closing select 'Close as not planned'

0 commit comments

Comments
 (0)