Skip to content
Open
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions .github/ISSUE_TEMPLATE/bug-report---.md
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown Linting #152

Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,22 @@ labels: bug
---

## Describe the bug

A clear and concise description of what the bug is.

### Steps to reproduce

Steps to reproduce the behavior.

### Expected behavior

A clear and concise description of what you expected to happen.

### Environment
- OS: [e.g. Arch Linux]
- Other details that you think may affect.

- OS: [e.g. Arch Linux]
- Other details that you think may affect.

### Additional context
Add any other context about the problem here.

Add any other context about the problem here.
5 changes: 4 additions & 1 deletion .github/ISSUE_TEMPLATE/feature-request---.md
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown Linting #152

Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@ labels: enhancement
---

## Summary

Brief explanation of the feature.

### Basic example

Include a basic example or links here.

### Motivation
Why are we doing this? What use cases does it support? What is the expected outcome?

Why are we doing this? What use cases does it support? What is the expected outcome?
32 changes: 32 additions & 0 deletions .gitignore
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You were missing a .gitignore and I ran some tests etc. with code tools locally, so I made one to just make it simple to not need to clean the directory tree all the time

Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Node.js
node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
package-lock.json

# Python virtual environment
.venv/
venv/

# Generated files
*.tmp

# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db

# IDE files
.vscode/
.idea/
*.swp
*.swo

# Temporary files
*.tmp
*.temp
5 changes: 0 additions & 5 deletions .idea/.gitignore
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what these were... should they be part of the repo?

This file was deleted.

12 changes: 0 additions & 12 deletions .idea/Best-README-Template.iml
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what these were... should they be part of the repo?

This file was deleted.

5 changes: 0 additions & 5 deletions .idea/codeStyles/codeStyleConfig.xml
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what these were... should they be part of the repo?

This file was deleted.

8 changes: 0 additions & 8 deletions .idea/modules.xml
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what these were... should they be part of the repo?

This file was deleted.

6 changes: 0 additions & 6 deletions .idea/vcs.xml
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what these were... should they be part of the repo?

This file was deleted.

32 changes: 32 additions & 0 deletions .markdownlint.json
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown Linting #152

Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"MD013": {
"line_length": 80,
"code_blocks": false,
"tables": false,
"headings": false
},
"MD033": {
"allowed_elements": [
"a",
"div",
"img",
"h1",
"h2",
"h3",
"h4",
"h5",
"h6",
"p",
"br",
"strong",
"em",
"details",
"summary",
"ol",
"ul",
"li"
]
},
"MD041": false,
"MD034": false
}
39 changes: 39 additions & 0 deletions .pre-commit-config.yaml
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New for this PR - auto generates the readme everytime there is an update to the config.json or the template file.

Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
fail_fast: false
minimum_pre_commit_version: "2.6.0"
repos:
# README Generator validation
- repo: https://github.com/actuarysailor/pre-commit-readme-generator
rev: v1.0.0
hooks:
- id: readme-generator-update
args: [configs/example.json, README.md, BLANK_README.md]

# Standard file checks
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v6.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-merge-conflict
- id: check-yaml
- id: check-json
- id: check-added-large-files
- id: check-case-conflict
- id: mixed-line-ending
args: ['--fix=lf']

# Markdown linting
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.45.0
hooks:
- id: markdownlint
args: ['--fix']
exclude: '^CHANGELOG\.md$'

# JSON formatting
- repo: https://github.com/pre-commit/mirrors-prettier
rev: v3.0.3
hooks:
- id: prettier
types: [json]
args: ['--write']
Loading