Skip to content

Commit 6aaf25b

Browse files
pphatdevpphatdev
committed
Add documentation for Git Bash compatibility, permission issues, PHP version detection, and PowerShell execution policy
- Created `git-bash-compatibility.md` to address command not found issues in Git Bash. - Added `permission-denied.md` to explain permission errors during PHP installation. - Introduced `php-version-not-found.md` to clarify PHP version detection issues. - Added `powershell-execution-policy.md` to resolve execution policy errors when running Pxp. - Added `dotnet-tools.json` for CSharpier configuration. - Created WiX project files (`Pxp.wixproj` and `Pxp.wxs`) for installer setup. - Added application icon `pxp.ico` for the installer. - Implemented `pxp.bat` and `pxp.ps1` scripts for command execution and PHP version management.
0 parents  commit 6aaf25b

25 files changed

+3574
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
name: Bug Report
2+
description: Report a bug or issue with pxp-cli
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the information below to help us resolve the issue.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of the bug
16+
placeholder: Tell us what went wrong
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: steps
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Run command `pxp ...`
27+
2. See error...
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: expected
33+
attributes:
34+
label: Expected Behavior
35+
description: What you expected to happen
36+
placeholder: Describe the expected outcome
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: actual
42+
attributes:
43+
label: Actual Behavior
44+
description: What actually happened
45+
placeholder: Describe what actually occurred
46+
validations:
47+
required: true
48+
49+
- type: textarea
50+
id: logs
51+
attributes:
52+
label: Error Messages / Logs
53+
description: Any error messages or relevant logs
54+
placeholder: Paste error messages here
55+
render: shell
56+
57+
- type: input
58+
id: pxp-version
59+
attributes:
60+
label: pxp Version
61+
description: Output of `pxp -v`
62+
placeholder: e.g., 1.3.0
63+
validations:
64+
required: true
65+
66+
- type: input
67+
id: windows-version
68+
attributes:
69+
label: Windows Version
70+
description: Your Windows version
71+
placeholder: e.g., Windows 11 Pro 23H2
72+
validations:
73+
required: true
74+
75+
- type: input
76+
id: powershell-version
77+
attributes:
78+
label: PowerShell Version
79+
description: Output of `$PSVersionTable.PSVersion`
80+
placeholder: e.g., 5.1.19041.4648
81+
validations:
82+
required: true
83+
84+
- type: input
85+
id: xampp-version
86+
attributes:
87+
label: XAMPP Version
88+
description: Your XAMPP version
89+
placeholder: e.g., 8.2.12
90+
validations:
91+
required: true
92+
93+
- type: textarea
94+
id: additional
95+
attributes:
96+
label: Additional Context
97+
description: Any other context about the problem
98+
placeholder: Add any other relevant information
99+
100+
- type: checkboxes
101+
id: terms
102+
attributes:
103+
label: Checklist
104+
options:
105+
- label: I have searched existing issues to avoid duplicates
106+
required: true
107+
- label: I have included all relevant information above
108+
required: true
109+
- label: I am running the latest version of pxp-cli
110+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement for pxp-cli
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a new feature! Please provide as much detail as possible.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: Is your feature request related to a problem? Describe it.
16+
placeholder: I'm frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe the solution you'd like to see
25+
placeholder: |
26+
I would like pxp to...
27+
28+
Example usage:
29+
```bash
30+
pxp command --option value
31+
```
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: alternatives
37+
attributes:
38+
label: Alternatives Considered
39+
description: Describe any alternative solutions you've considered
40+
placeholder: I've considered...
41+
42+
- type: textarea
43+
id: use-case
44+
attributes:
45+
label: Use Case
46+
description: Explain how this feature would be beneficial
47+
placeholder: This feature would help developers who...
48+
validations:
49+
required: true
50+
51+
- type: textarea
52+
id: examples
53+
attributes:
54+
label: Examples
55+
description: Provide examples of how the feature would work
56+
placeholder: |
57+
```bash
58+
# Example 1
59+
pxp new-command arg1 arg2
60+
61+
# Example 2
62+
pxp existing-command --new-flag
63+
```
64+
65+
- type: textarea
66+
id: additional
67+
attributes:
68+
label: Additional Context
69+
description: Any other context, screenshots, or references
70+
placeholder: Add any other relevant information
71+
72+
- type: checkboxes
73+
id: terms
74+
attributes:
75+
label: Checklist
76+
options:
77+
- label: I have searched existing issues and feature requests
78+
required: true
79+
- label: This feature aligns with the project's goals
80+
required: true
81+
- label: I am willing to help implement this feature
82+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Pull Request
2+
3+
## Description
4+
5+
<!-- Provide a clear description of what this PR does -->
6+
7+
## Type of Change
8+
9+
<!-- Mark the appropriate option with an 'x' -->
10+
11+
- [ ] Bug fix (non-breaking change that fixes an issue)
12+
- [ ] New feature (non-breaking change that adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Code refactoring
16+
- [ ] Performance improvement
17+
- [ ] Other (please describe):
18+
19+
## Related Issue
20+
21+
<!-- Link to the issue this PR addresses -->
22+
Closes #(issue number)
23+
24+
## Changes Made
25+
26+
<!-- List the specific changes made in this PR -->
27+
28+
-
29+
-
30+
-
31+
32+
## Testing
33+
34+
<!-- Describe the testing you've done -->
35+
36+
### Test Environment
37+
38+
- Windows Version:
39+
- PowerShell Version:
40+
- XAMPP Version:
41+
- pxp Version:
42+
43+
### Test Cases
44+
45+
<!-- Describe what you tested -->
46+
47+
- [ ] Tested on Windows 10
48+
- [ ] Tested on Windows 11
49+
- [ ] Tested in PowerShell 5.1
50+
- [ ] Tested in PowerShell 7+
51+
- [ ] Tested with PHP 7.x
52+
- [ ] Tested with PHP 8.x
53+
- [ ] Manual testing completed
54+
- [ ] All existing features still work
55+
56+
### Commands Tested
57+
58+
```bash
59+
# List the commands you tested
60+
pxp command1
61+
pxp command2
62+
```
63+
64+
### Test Results
65+
66+
<!-- Describe the results of your testing -->
67+
68+
## Screenshots (if applicable)
69+
70+
<!-- Add screenshots to demonstrate changes -->
71+
72+
## Checklist
73+
74+
<!-- Mark completed items with an 'x' -->
75+
76+
- [ ] My code follows the project's coding style
77+
- [ ] I have performed a self-review of my own code
78+
- [ ] I have commented my code, particularly in hard-to-understand areas
79+
- [ ] I have made corresponding changes to the documentation
80+
- [ ] My changes generate no new warnings or errors
81+
- [ ] I have tested my changes thoroughly
82+
- [ ] All existing tests pass
83+
- [ ] I have updated the CHANGELOG.md (if applicable)
84+
- [ ] I have added examples/documentation for new features
85+
86+
## Breaking Changes
87+
88+
<!-- If this PR introduces breaking changes, describe them here -->
89+
90+
- [ ] This PR does NOT introduce breaking changes
91+
92+
<!-- If it does, describe what breaks and how users should adapt -->
93+
94+
## Additional Notes
95+
96+
<!-- Any additional information that reviewers should know -->
97+
98+
## For Maintainers
99+
100+
<!-- Maintainers can fill this section -->
101+
102+
- [ ] Code reviewed
103+
- [ ] Tests verified
104+
- [ ] Documentation reviewed
105+
- [ ] Ready to merge

0 commit comments

Comments
 (0)