Skip to content

Commit

Permalink
chore: fix linting and add vocab
Browse files Browse the repository at this point in the history
  • Loading branch information
gphorvath committed Dec 21, 2024
1 parent b902ebf commit 51955e8
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 9 deletions.
7 changes: 6 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,21 @@ assignees: ''
---

## Description

Provide a clear and concise description of the bug.

## Steps to Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. See the error

## Expected Behavior

Provide a clear and concise description of what you expected to happen.

## Additional Context
Add any other context about the problem here (e.g., screenshots, environment, versions, etc.).

Add any other context about the problem here (e.g., screenshots, environment, versions, etc.).
7 changes: 6 additions & 1 deletion .github/ISSUE_TEMPLATE/chore.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,23 @@ assignees: ''
---

## Description

Provide a brief description of the chore needed.

## Motivation

Why is this chore important? What problems does it solve or prevent?

## Technical Details

Include any specific technical details, dependencies, or areas that will be affected.

## Risk Assessment

- Impact level: (Low/Medium/High)
- Areas affected:
- Potential side effects:

## Additional Notes
Include any other relevant information or context.

Include any other relevant information or context.
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,13 @@ assignees: ''
**so that** [benefit].

## Proposed Solution

Provide a clear description of what you want to happen.

## Alternatives Considered

Provide a clear description of any alternative solutions or features you've considered.

## Additional Context

Add any other context or screenshots about the feature request here.
13 changes: 11 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@
---
name: Pull Request
title: ""
---

## Description

Brief description of the changes

## Type of change

- [ ] Bug fix
- [ ] New feature
- [ ] Breaking change
- [ ] Documentation update

## How Has This Been Tested?

Describe how you tested these changes.

## Checklist:
## Checklist

- [ ] Your code is clean, understandable, and commented.
- [ ] All workflows are passing.
Expand All @@ -19,4 +27,5 @@ Describe how you tested these changes.
- [ ] Documentation is sufficient for other contributors (or your future self) to work with your code.

## Related Issues
Fixes #(issue)

Fixes #(issue)
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
MIT License
# MIT License

Copyright (c) 2024 Gregory Horvath

Check warning on line 3 in LICENSE

View workflow job for this annotation

GitHub Actions / Check Spelling

Unknown word (Horvath)

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Swiss Army Knife

![](docs/images/swiss-army-knife.jpeg)
![Swiss Army Knife](docs/images/swiss-army-knife.jpeg)

## Overview

Expand Down
7 changes: 5 additions & 2 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,13 @@
"dictionaryDefinitions": [],
"dictionaries": [],
"words": [
"commitlint",
"lycheeignore",
"lycheeverse",
"trufflehog",
"trufflesecurity",
"lycheeignore",
"commitlint"
"wontfix",
"yogevbd"
],
"ignoreWords": [],
"import": []
Expand Down
2 changes: 1 addition & 1 deletion docs/project-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ An example you can use for your project is provided here:
└── .github
└── PULL_REQUEST_TEMPLATE
└── pull_request_template.yaml
```
```

0 comments on commit 51955e8

Please sign in to comment.