Skip to content

Commit 2e58981

Browse files
TunaCumaTunaCuma
authored
Merge pull request #5 from TunaCuma/add-project-infrastructure
Add project infrastructure
2 parents 397b544 + 50a96a9 commit 2e58981

File tree

8 files changed

+620
-0
lines changed

8 files changed

+620
-0
lines changed

‎.github/CONTRIBUTING.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Contributing
2+
3+
## Reporting Bugs
4+
5+
Before creating a bug report:
6+
7+
1. Search existing issues
8+
2. Update to the latest version
9+
3. Use the bug report template
10+
11+
Include:
12+
- Zsh version (`zsh --version`)
13+
- Man version (`man --version`)
14+
- Your configuration
15+
- Steps to reproduce
16+
- Expected vs actual behavior
17+
18+
## Development Setup
19+
20+
```bash
21+
# Fork and clone
22+
git clone https://github.com/YOUR_USERNAME/zsh-vi-man.git
23+
cd zsh-vi-man
24+
25+
# Create a branch
26+
git checkout -b feature/your-feature-name
27+
28+
# Test your changes
29+
zsh test_patterns.zsh
30+
```
31+
32+
## Code Style
33+
34+
- 2 spaces for indentation
35+
- Lines under 100 characters
36+
- Add comments for complex logic
37+
- Follow existing patterns
38+
39+
## Commit Messages
40+
41+
Use conventional commit format:
42+
43+
```
44+
feat: add support for custom pager options
45+
fix: handle options with equals sign correctly
46+
docs: update installation instructions
47+
test: add tests for slash-separated options
48+
```
49+
50+
## Writing Tests
51+
52+
Add tests to `test_patterns.zsh` for pattern changes:
53+
54+
```zsh
55+
pattern=$(build_your_pattern_function "input")
56+
57+
assert_matches "$pattern" \
58+
" expected match line" \
59+
"Description of what should match"
60+
```
61+
62+
## Pull Requests
63+
64+
1. Create PR using the template
65+
2. Link related issues (use "Fixes #123")
66+
3. Ensure tests pass
67+
4. Respond to review feedback
68+
69+
## CI/CD
70+
71+
GitHub Actions automatically:
72+
- Runs pattern tests
73+
- Verifies plugin loads
74+
- Tests on Ubuntu and macOS
75+
- Checks compatibility with plugin managers
76+
- Runs shellcheck
77+

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or unexpected behavior
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
A clear description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
1. Type command: `...`
16+
2. Press `Escape` to enter vi normal mode
17+
3. Move cursor to `...`
18+
4. Press `K`
19+
5. See error...
20+
21+
## Expected Behavior
22+
23+
What you expected to happen.
24+
25+
## Actual Behavior
26+
27+
What actually happened.
28+
29+
## Environment
30+
31+
Please provide the following information:
32+
33+
**Zsh version:**
34+
```bash
35+
zsh --version
36+
```
37+
38+
**Man version:**
39+
```bash
40+
man --version
41+
```
42+
43+
**Plugin configuration:**
44+
```bash
45+
echo "ZVM_MAN_KEY: $ZVM_MAN_KEY"
46+
echo "ZVM_MAN_PAGER: $ZVM_MAN_PAGER"
47+
echo "MANPAGER: $MANPAGER"
48+
echo "PAGER: $PAGER"
49+
echo "LESS: $LESS"
50+
```
51+
52+
**Plugin manager:** (e.g., zinit, oh-my-zsh, manual)
53+
54+
**Other vi-mode plugins:**
55+
- [ ] zsh-vi-mode
56+
- [ ] Other (please specify):
57+
58+
**Operating System:**
59+
- [ ] macOS (version: )
60+
- [ ] Linux (distro: )
61+
- [ ] Other:
62+
63+
## Additional Context
64+
65+
Add any other context about the problem here. Screenshots are helpful!
66+
67+
## Relevant Configuration
68+
69+
If applicable, share relevant parts of your `.zshrc`:
70+
71+
```zsh
72+
# Your zsh-vi-man configuration
73+
```
74+

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Discussions
4+
url: https://github.com/TunaCuma/zsh-vi-man/discussions
5+
about: Ask questions or discuss ideas
6+
- name: Documentation
7+
url: https://github.com/TunaCuma/zsh-vi-man#readme
8+
about: Check the README for usage and configuration
9+

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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 description of the feature you'd like to see.
12+
13+
## Use Case
14+
15+
Describe the problem this feature would solve. Why would this be useful?
16+
17+
## Proposed Solution
18+
19+
How do you envision this working? Any specific implementation ideas?
20+
21+
## Alternatives Considered
22+
23+
Have you considered any alternative solutions or workarounds?
24+
25+
## Additional Context
26+
27+
Add any other context, screenshots, or examples about the feature request here.
28+

‎.github/pull_request_template.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Description
2+
3+
Briefly describe the changes in this PR.
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix
8+
- [ ] New feature
9+
- [ ] Breaking change
10+
- [ ] Documentation update
11+
12+
## Related Issues
13+
14+
Fixes #
15+
16+
## Testing
17+
18+
- [ ] Ran `zsh test_patterns.zsh` - all tests pass
19+
- [ ] Tested manually
20+
21+
Test environment:
22+
- Zsh version:
23+
- OS:
24+
25+
## Checklist
26+
27+
- [ ] Code follows project style
28+
- [ ] Self-reviewed
29+
- [ ] Tests pass
30+
- [ ] Documentation updated (if needed)
31+

0 commit comments

Comments
 (0)