Skip to content

Commit 6983971

Browse files
Merge branch 'main' of github.com:openproblems-bio/openproblems into main
2 parents d453915 + a8d2086 commit 6983971

25 files changed

Lines changed: 967 additions & 399 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@ assignees: ''
88
---
99

1010
- [ ] I have checked that this issue has not already been reported.
11-
- [ ] I have confirmed this bug exists on the master branch of openproblems.
11+
- [ ] I have confirmed this bug exists on the `main` branch of openproblems.
1212

1313
---
1414

15-
**Note**: Please read [this guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing how to provide the necessary information for us to reproduce your bug.
16-
15+
**Note**: Please read [this
16+
guide](https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports) detailing
17+
how to provide the necessary information for us to reproduce your bug.
1718

1819
### Minimal code sample (that we can copy&paste without having any data)
1920

@@ -29,6 +30,7 @@ assignees: ''
2930

3031
<details>
3132

32-
[Paste the output of scanpy.logging.print_versions() leaving a blank line after the details tag]
33+
<!-- Paste the output of scanpy.logging.print_versions() leaving a blank line after the
34+
details tag -->
3335

3436
</details>

.github/ISSUE_TEMPLATE/propose-a-new-dataset.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ about: Suggest new data for one or more tasks
44
title: ''
55
labels: enhancement, dataset
66
assignees: ''
7-
87
---
98

109
**What is the dataset?**
@@ -14,4 +13,5 @@ Describe it briefly and include a citation.
1413
Include a link to the publicly available data.
1514

1615
**Which tasks could it be used for?**
17-
If the dataset is to be used for a task that is not yet included in the code base, use the issue template *propose a new task* instead.
16+
If the dataset is to be used for a task that is not yet included in the code base, use
17+
the issue template *propose a new task* instead.

.github/ISSUE_TEMPLATE/propose-a-new-method.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ Describe it briefly and include a citation.
1414
Include a link to the publicly available codebase.
1515

1616
**Which task(s) could it be used for?**
17-
If the method is to be used for a task that is not yet included in the code base, use the issue template *propose a new task* instead.
17+
If the method is to be used for a task that is not yet included in the code base, use
18+
the issue template *propose a new task* instead.

.github/ISSUE_TEMPLATE/propose-a-new-metric.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ Describe it briefly and include a citation if applicable.
1414
Include a link to the publicly available codebase if available.
1515

1616
**Which task(s) could it be used for?**
17-
If the method is to be used for a task that is not yet included in the code base, use the issue template *propose a new task* instead.
17+
If the method is to be used for a task that is not yet included in the code base, use
18+
the issue template *propose a new task* instead.

.github/ISSUE_TEMPLATE/propose-a-new-task.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ Include links to at least one publicly available dataset that could be used.
1717
Include links to codebases of at least two methods that perform the task.
1818

1919
**Propose metrics**
20-
Describe at least one metric by which to measure success on the task. It must be able to be applied to the proposed datasets.
20+
Describe at least one metric by which to measure success on the task. It must be able to
21+
be applied to the proposed datasets.

.github/pull_request_template.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,18 @@
1313
### Testing
1414

1515
* [ ] This submission was written on a forked copy of SingleCellOpenProblems
16-
* [ ] GitHub Actions "Run Benchmark" tests are passing on this base branch of this pull request (include link to passed test: )
17-
* [ ] If this pull request is not ready for review (including passing the "Run Benchmark" tests), I will open this PR as a draft (click on the down arrow next to the "Create Pull Request" button)
16+
* [ ] GitHub Actions "Run Benchmark" tests are passing on this base branch of this pull
17+
request (include link to passed test: )
18+
* [ ] If this pull request is not ready for review (including passing the "Run
19+
Benchmark" tests), I will open this PR as a draft (click on the down arrow next to the
20+
"Create Pull Request" button)
1821

1922
### Submission guidelines
2023

21-
* [ ] This submission follows the guidelines in our [Contributing](../blob/master/CONTRIBUTING.md) document
22-
* [ ] I have checked to ensure there aren't other open [Pull Requests](../pulls) for the same update/change
24+
* [ ] This submission follows the guidelines in our
25+
[Contributing](../blob/master/CONTRIBUTING.md) document
26+
* [ ] I have checked to ensure there aren't other open [Pull Requests](../pulls) for the
27+
same update/change
2328

2429
### PR review checklist
2530

@@ -28,7 +33,9 @@ This PR will be evaluated on the basis of the following checks:
2833
* [ ] The task addresses a valid open problem in single-cell analysis
2934
* [ ] The latest version of master is merged and tested
3035
* [ ] The methods/metrics are imported to `__init__.py` and were tested in the pipeline
31-
* [ ] Method and metric decorators are annotated with paper title, year, author, code version, and date
36+
* [ ] Method and metric decorators are annotated with paper title, year, author, code
37+
version, and date
3238
* [ ] The README gives an outline of the methods, metrics and datasets in the folder
3339
* [ ] The README provides a satisfactory task explanation (for new tasks)
34-
* [ ] The sample test data is appropriate to test implementation of all methods and metrics (for new tasks)
40+
* [ ] The sample test data is appropriate to test implementation of all methods and
41+
metrics (for new tasks)

.pre-commit-config.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,8 @@ repos:
3434
- id: style-files
3535
- id: lintr
3636
verbose: true
37+
- repo: https://github.com/igorshubovych/markdownlint-cli
38+
rev: v0.32.0
39+
hooks:
40+
- id: markdownlint-fix
41+
exclude: (SAGEMAKER.md|.github/ISSUE_TEMPLATE/bug_report.md|.github/pull_request_template.md)

CODE_OF_CONDUCT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ members of the project's leadership.
6868
## Attribution
6969

7070
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71-
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
7272

7373
[homepage]: https://www.contributor-covenant.org
7474

7575
For answers to common questions about this code of conduct, see
76-
https://www.contributor-covenant.org/faq
76+
<https://www.contributor-covenant.org/faq>

0 commit comments

Comments
 (0)