Skip to content

Commit

Permalink
Merge pull request #6 from ROVI-org/docs
Browse files Browse the repository at this point in the history
Fix documentation issue template
  • Loading branch information
c-randall authored Sep 16, 2024
2 parents 8abe035 + 4ad33a5 commit de974dc
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 9 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ body:
attributes:
value: Thanks for taking the time to fill out this report!

- type: radio
- type: dropdown
id: problem-type
attributes:
label: Problem/request type
description: What are you trying to get fixed or added?
options:
- label: typo
- label: example request
- label: broken link
- label: other
- typo
- example request
- broken link
- other
validations:
required: true

Expand Down
5 changes: 3 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,6 @@ Please add a line in the relevant section of [CHANGELOG.md](https://github.com/R
The optional `-- format` and `-- write` arguments (see above) attempt to correct formatting issues prior to running the linter, and spelling mistakes prior to running the spellcheck, respectively. You can also run all of the above checks using `$ nox -s pre-commit` instead of running them individually.

## Further checks:
- [ ] Code is commented, particularly in hard-to-understand areas
- [ ] Tests are added that prove fix is effective or that feature works
- [ ] The documentation builds: `$ nox -s docs`.
- [ ] Code is commented, particularly in hard-to-understand areas.
- [ ] Tests are added that prove fix is effective or that feature works.
10 changes: 8 additions & 2 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,23 @@ on:
push:
paths-ignore:
- '*.md'
- '*.txt'
- 'README*'
- 'LICENSE*'
- 'CHANGELOG*'
- 'docs/*'
- 'images/*'
- '.github/ISSUE_TEMPLATE/*'

pull_request:
branches: [main]
paths-ignore:
- '*.md'
- '*.txt'
- 'README*'
- 'LICENSE*'
- 'CHANGELOG*'
- 'docs/*'
- 'images/*'
- '.github/ISSUE_TEMPLATE/*'

jobs:
lint:
Expand Down

0 comments on commit de974dc

Please sign in to comment.