Skip to content

Commit 2af717c

Browse files
dlabajdlabaj
committed
chore: Updated for AI readiness for this repo.
1 parent c92030e commit 2af717c

28 files changed

Lines changed: 897 additions & 44 deletions

‎.DS_Store‎

8 KB
Binary file not shown.

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: '[Bug]: '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Bug Description
10+
11+
<!-- A clear and concise description of what the bug is -->
12+
13+
## Steps to Reproduce
14+
15+
<!-- Steps to reproduce the behavior -->
16+
17+
1. Run command: `patternfly-cli ...` or `pf ...`
18+
2.
19+
3.
20+
4. See error
21+
22+
## Expected Behavior
23+
24+
<!-- A clear and concise description of what you expected to happen -->
25+
26+
## Actual Behavior
27+
28+
<!-- What actually happened -->
29+
30+
## Error Output
31+
32+
<!-- If applicable, paste the complete error message or stack trace -->
33+
34+
```
35+
Paste error output here
36+
```
37+
38+
## Environment
39+
40+
- **OS**: <!-- e.g., macOS 14.2, Ubuntu 22.04, Windows 11 -->
41+
- **Node version**: <!-- run `node --version` -->
42+
- **npm version**: <!-- run `npm --version` -->
43+
- **PatternFly CLI version**: <!-- run `patternfly-cli --version` or `pf --version` -->
44+
- **Shell**: <!-- e.g., bash, zsh, PowerShell -->
45+
46+
## Additional Context
47+
48+
<!-- Add any other context about the problem here, such as screenshots, logs, or configuration files -->
49+
50+
## Possible Solution
51+
52+
<!-- Optional: suggest a fix or reason for the bug -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: PatternFly Documentation
4+
url: https://www.patternfly.org/
5+
about: Visit the official PatternFly documentation
6+
- name: PatternFly Community
7+
url: https://github.com/patternfly
8+
about: Explore other PatternFly projects and resources

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement
4+
title: '[Feature]: '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Feature Description
10+
11+
<!-- A clear and concise description of the feature you'd like to see -->
12+
13+
## Problem Statement
14+
15+
<!-- Describe the problem this feature would solve. Ex: I'm always frustrated when... -->
16+
17+
## Proposed Solution
18+
19+
<!-- Describe how you envision this feature working -->
20+
21+
## Example Usage
22+
23+
<!-- Show how users would interact with this feature -->
24+
25+
```bash
26+
# Example command or usage
27+
pf new-command --option value
28+
```
29+
30+
## Alternatives Considered
31+
32+
<!-- Describe any alternative solutions or features you've considered -->
33+
34+
## Additional Context
35+
36+
<!-- Add any other context, screenshots, or examples about the feature request here -->
37+
38+
## Benefits
39+
40+
<!-- Explain how this feature would benefit PatternFly CLI users -->
41+
42+
-
43+
-
44+
-

‎.github/LINTING.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Linting Guide
2+
3+
This project uses multiple linters to maintain code and documentation quality.
4+
5+
## Available Linters
6+
7+
### ESLint (JavaScript/TypeScript)
8+
9+
Lints TypeScript source code in the `src/` directory.
10+
11+
```bash
12+
npm run lint:js # Check for issues
13+
npm run lint:js:fix # Auto-fix issues
14+
```
15+
16+
### Markdownlint (Documentation)
17+
18+
Validates all markdown files (`.md`) for consistency and best practices.
19+
20+
```bash
21+
npm run lint:md # Check markdown files
22+
npm run lint:md:fix # Auto-fix markdown issues
23+
```
24+
25+
Configuration: [.markdownlint.json](../.markdownlint.json)
26+
27+
### Actionlint (GitHub Actions)
28+
29+
Validates GitHub Actions workflow files automatically on pull requests and pushes to main.
30+
31+
This runs automatically in CI when workflow files are modified.
32+
33+
## Run All Linters
34+
35+
```bash
36+
npm run lint # Run all linters
37+
npm run lint:fix # Auto-fix all issues
38+
```
39+
40+
## CI/CD Integration
41+
42+
- **Lint workflow** (`.github/workflows/lint.yml`) - Runs all linters after successful build
43+
- **Markdownlint workflow** (`.github/workflows/markdownlint.yml`) - Runs on markdown file changes
44+
- **Actionlint workflow** (`.github/workflows/actionlint.yml`) - Runs on workflow file changes
45+
46+
## Configuration Files
47+
48+
- [.eslintrc](../.eslintrc) - ESLint configuration (if exists)
49+
- [.markdownlint.json](../.markdownlint.json) - Markdownlint rules
50+
- [.markdownlintignore](../.markdownlintignore) - Files to exclude from markdown linting
51+
52+
## Ignored Paths
53+
54+
The following are automatically ignored by linters:
55+
56+
- `node_modules/` - Dependencies
57+
- `dist/` - Build output
58+
- `.agentready/` - Agent reports
59+
- `CHANGELOG.md` - Auto-generated by semantic-release

‎.github/pull_request_template.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
## Description
2+
3+
<!-- Provide a brief description of the changes in this PR -->
4+
5+
## Type of Change
6+
7+
<!-- Mark the relevant option with an "x" -->
8+
9+
- [ ] Bug fix (non-breaking change which fixes an issue)
10+
- [ ] New feature (non-breaking change which adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Refactoring (no functional changes)
14+
- [ ] Dependency update
15+
- [ ] Other (please describe):
16+
17+
## Related Issues
18+
19+
<!-- Link to related issues using #issue-number -->
20+
21+
Fixes #
22+
Relates to #
23+
24+
## Changes Made
25+
26+
<!-- List the key changes made in this PR -->
27+
28+
-
29+
-
30+
-
31+
32+
## Testing
33+
34+
<!-- Describe the tests you ran and how to reproduce them -->
35+
36+
- [ ] Existing tests pass (`npm test`)
37+
- [ ] Added new tests for changes
38+
- [ ] Manually tested locally (`npm run build && npm install -g`)
39+
- [ ] Linting passes (`npm run lint`)
40+
41+
### Test Instructions
42+
43+
<!-- Provide step-by-step instructions to test these changes -->
44+
45+
1.
46+
2.
47+
3.
48+
49+
## Checklist
50+
51+
- [ ] My code follows the code style of this project
52+
- [ ] I have added/updated tests as appropriate
53+
- [ ] I have updated the documentation (if applicable)
54+
- [ ] My commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/) specification
55+
- [ ] All imports use `.js` extensions (ESM requirement)
56+
- [ ] TypeScript compilation succeeds (`npm run build`)
57+
58+
## Screenshots (if applicable)
59+
60+
<!-- Add screenshots to help explain your changes -->
61+
62+
## Additional Notes
63+
64+
<!-- Any additional information that reviewers should know -->

‎.github/workflows/actionlint.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Actionlint
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- '.github/workflows/*.yml'
7+
- '.github/workflows/*.yaml'
8+
push:
9+
branches:
10+
- main
11+
paths:
12+
- '.github/workflows/*.yml'
13+
- '.github/workflows/*.yaml'
14+
15+
jobs:
16+
actionlint:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Checkout code
20+
uses: actions/checkout@v4
21+
22+
- name: Run actionlint
23+
uses: reviewdog/action-actionlint@v1
24+
with:
25+
github_token: ${{ secrets.GITHUB_TOKEN }}
26+
reporter: github-pr-review
27+
filter_mode: nofilter
28+
fail_on_error: true

‎.github/workflows/markdownlint.yml‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Markdownlint
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- '**.md'
7+
push:
8+
branches:
9+
- main
10+
paths:
11+
- '**.md'
12+
13+
jobs:
14+
markdownlint:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout code
18+
uses: actions/checkout@v4
19+
20+
- name: Setup Node.js
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: '20'
24+
25+
- name: Install dependencies
26+
run: npm ci
27+
28+
- name: Run markdownlint
29+
run: npm run lint:md

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ yarn-debug.log*
66
yarn-error.log*
77
lerna-debug.log*
88

9+
# AI analysis
10+
.agentready
11+
912
# Diagnostic reports (https://nodejs.org/api/report.html)
1013
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
1114

‎.markdownlint.json‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"default": true,
3+
"MD003": {
4+
"style": "atx"
5+
},
6+
"MD007": {
7+
"indent": 2
8+
},
9+
"MD013": {
10+
"line_length": 120,
11+
"code_blocks": false,
12+
"tables": false
13+
},
14+
"MD024": {
15+
"siblings_only": true
16+
},
17+
"MD033": false,
18+
"MD041": false
19+
}

0 commit comments

Comments
 (0)