Skip to content

Commit 3dc8891

Browse files
committed
Add: ci to check links and clearer categories
1 parent 287bf53 commit 3dc8891

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed

.github/ISSUE_TEMPLATE/submit-software-for-review.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ existing community please check below:
5454
- [ ] [Pangeo][pangeoWebsite]
5555
- [ ] My package adheres to the [Pangeo standards listed in the pyOpenSci peer review guidebook][PangeoCollaboration]
5656

57-
5857
> ** Please fill out a pre-submission inquiry before submitting a data visualization package.*
5958
6059

@@ -68,15 +67,15 @@ existing community please check below:
6867

6968
## Technical checks
7069

71-
For details about the pyOpenSci packaging requirements, see our [packaging guide][PackagingGuide]. Confirm each of the following by checking the box. This package:
70+
For details about the pyOpenSci packaging requirements, see our [packaging guide][PackagingGuide]. Confirm each of the following by checking the box. This package:
7271

7372
- [ ] does not violate the Terms of Service of any service it interacts with.
74-
- [ ] has an [OSI approved license][OsiApprovedLicense].
73+
- [ ] uses an [OSI approved license][OsiApprovedLicense].
7574
- [ ] contains a README with instructions for installing the development version.
7675
- [ ] includes documentation with examples for all functions.
77-
- [ ] contains a vignette with examples of its essential functions and uses.
76+
- [ ] contains a tutorial with examples of its essential functions and uses.
7877
- [ ] has a test suite.
79-
- [ ] has continuous integration, such as Travis CI, AppVeyor, CircleCI, and/or others.
78+
- [ ] has continuous integration setup, such as GitHub Actions CircleCI, and/or others.
8079

8180
## Publication Options
8281

@@ -99,7 +98,12 @@ This option will allow reviewers to open smaller issues that can then be linked
9998

10099
- [x] Yes I am OK with reviewers submitting requested changes as issues to my repo. Reviewers will then link to the issues in their submitted review.
101100

102-
## Code of conduct
101+
Confirm each of the following by checking the box.
102+
103+
- [ ] I have read the [author guide](https://www.pyopensci.org/software-peer-review/how-to/author-guide.html).
104+
- [ ] I expect to maintain this package for at least 2 years and can help find a replacement for the maintainer (team) if needed.
105+
106+
## Code of Conduct
103107

104108
- [ ] I agree to abide by [pyOpenSci's Code of Conduct][PyOpenSciCodeOfConduct] during the review process and in maintaining my package should it be accepted.
105109

.github/workflows/check-links.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: check links
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
markdown-link-check:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@master
14+
- uses: gaurav-nelson/github-action-markdown-link-check@v1

0 commit comments

Comments
 (0)