Skip to content

Commit

Permalink
Added yamllint/markdownlint. (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
markdorison authored Aug 3, 2020
1 parent 596e869 commit a3544df
Show file tree
Hide file tree
Showing 8 changed files with 77 additions and 17 deletions.
26 changes: 17 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,32 +8,40 @@ assignees: ''
---

## Description

<!-- A clear and concise description of what the bug is. -->

## To Reproduce

<!-- Steps to reproduce the behavior: -->
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Expected Behavior

<!-- A clear and concise description of what you expected to happen. -->

## Screenshots

<!-- If applicable, add screenshots to help explain your problem. -->

## Environment
### Desktop (please complete the following information):
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

### Smartphone (please complete the following information):
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
### Desktop (please complete the following information)

- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

### Smartphone (please complete the following information)

- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

## Additional context

<!-- Add any other context about the problem here. -->
11 changes: 9 additions & 2 deletions .github/ISSUE_TEMPLATE/dependency_security_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,27 @@ labels: ''
assignees: ''

---
<!-- Please apply all relevant labels including those to specify which sites are affected. -->
<!-- Please apply all relevant labels including those to specify which sites
are affected. -->

## Description

<!-- Provide documentation for the release that we should be updating to. -->
<!-- [Releases for Drupal core](https://www.drupal.org/project/drupal/releases) -->

## Release Notes

<!-- Link to release notes for the new version. -->

## Breaking Changes

<!-- Denote any breaking changes from the release notes. -->

## Security Concerns

<!-- Denote any security concerns or additional security steps. -->

## Additional Actions
<!-- Denote additional actions that need to be taken our tested with this release. -->

<!-- Denote additional actions that need to be taken our tested with this
release. -->
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/epic.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ assignees: ''
## Tasks
<!-- Reference issues that are encompassed by this epic. -->

- [ ]
- [ ]
- [ ]
10 changes: 8 additions & 2 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,19 @@ assignees: ''
---

## Description
<!-- A clear and concise description of what the problem is. Is your request related to a problem? Ex. I'm always frustrated when [...] -->

<!-- A clear and concise description of what the problem is. Is your request
related to a problem? Ex. I'm always frustrated when [...] -->

## Proposed Solution

<!-- A clear and concise description of what you want to happen. -->

## Alternatives Considered
<!-- A clear and concise description of any alternative solutions or features you've considered. -->

<!-- A clear and concise description of any alternative solutions or features
you've considered. -->

## Additional Context

<!-- Add any other context or screenshots about the feature request here. -->
11 changes: 8 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Description

<!--- Describe your changes in detail. -->

## Motivation / Context
Expand All @@ -17,7 +18,11 @@
<!--- Do they warrant new sections within the current documentation? --->

## PR Author Checklist
- [ ] My PR description includes a reference to a ticket or other "motivation" for these changes.

- [ ] My PR description includes a reference to a ticket or other "motivation"
for these changes.
- [ ] My PR description includes details of how I tested these changes.
- [ ] My PR description includes testing instructions for reviewers with links to the testing environment, if applicable.
- [ ] My code includes documentation updates to existing documentation or new sections if applicable.
- [ ] My PR description includes testing instructions for reviewers with links
to the testing environment, if applicable.
- [ ] My code includes documentation updates to existing documentation or new
sections if applicable.
27 changes: 27 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Code Analysis
on: # yamllint disable-line rule:truthy
# Trigger the workflow on pushes to the default branch and all pull requests.
push:
branches:
- main
pull_request:

jobs:
markdownlint:
runs-on: ubuntu-latest
steps:
- name: Lint markdown files
uses: avto-dev/markdown-lint@v1
with:
args: 'README.md .github/'

yaml-lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2

- name: YAML lint
uses: ibiqlik/action-yamllint@master
with:
config_file: .yamllint.yml
2 changes: 2 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
MD041: false
5 changes: 5 additions & 0 deletions .yamllint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
extends: default

rules:
line-length: disable

0 comments on commit a3544df

Please sign in to comment.