Skip to content

Commit 11da1d5

Browse files
muhammedaksammuhammedaksam
authored
Merge pull request #85 from muhammedaksam/develop
chore: add templates and docs for branching model
2 parents 5975e7f + 01bdabc commit 11da1d5

7 files changed

Lines changed: 298 additions & 86 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 50 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,62 @@
11
---
2-
name: Bug report
3-
about: Create a report to help us improve
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
2+
name: 🐛 Bug Report
3+
about: Create a report to help us improve WAHA-TUI
4+
title: "[BUG] "
5+
labels: "bug"
6+
assignees: ""
87
---
98

10-
**Describe the bug**
9+
## Describe the bug
10+
1111
A clear and concise description of what the bug is.
1212

13-
**To Reproduce**
13+
## To Reproduce
14+
1415
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
1916

20-
**Expected behavior**
17+
1. Run `waha-tui` with `--debug` option as `waha-tui --debug`.
18+
2. Perform action '...'
19+
3. See error
20+
21+
## Expected behavior
22+
2123
A clear and concise description of what you expected to happen.
2224

23-
**Screenshots**
24-
If applicable, add screenshots to help explain your problem.
25+
## Environment
26+
27+
- **WAHA-TUI Version:** [e.g. 1.6.3]
28+
- **Bun Version:** [e.g. 1.1.0]
29+
- **OS:** [e.g. Ubuntu 22.04, macOS Sonoma, Windows 11 (WSL2)]
30+
- **Terminal Emulator:** [e.g. Kitty, iTerm2, Windows Terminal]
31+
- **WAHA Engine:** [e.g. WEBJS, NOWEB, GOWS]
32+
33+
## WAHA Configuration
34+
35+
- [ ] I am using the latest version of WAHA-TUI.
36+
- [ ] I have a running WAHA server accessible at the configured URL.
37+
- [ ] I have enabled `tagsEventsOn` if using WEBJS engine (if applicable).
38+
39+
## Debug Logs
40+
41+
Please run the application with debug mode enabled and provide the relevant logs.
42+
43+
```bash
44+
waha-tui --debug
45+
# or
46+
bun dev --debug
47+
```
48+
49+
Logs are usually located at `~/.config/waha-tui/debug.log`. Please **sanitize any sensitive information** (phone numbers, API keys) before pasting here.
50+
51+
<details>
52+
<summary>Click to expand debug logs</summary>
53+
54+
```text
55+
# Paste logs here
56+
```
2557

26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
58+
</details>
3059

31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
60+
### Additional context
3661

37-
**Additional context**
38-
Add any other context about the problem here.
62+
Add any other context about the problem here (e.g., screenshots of the TUI layout issues).

‎.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: false
2+
contact_links:
3+
- name: 💬 Ask a question
4+
url: https://github.com/muhammedaksam/waha-tui/discussions
5+
about: Ask a question or get help with WAHA-TUI
6+
- name: 📖 Documentation
7+
url: https://github.com/muhammedaksam/waha-tui#readme
8+
about: Read the official WAHA-TUI documentation

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,27 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
4-
title: ''
5-
labels: ''
6-
assignees: ''
7-
2+
name: 🚀 Feature Request
3+
about: Suggest an idea for WAHA-TUI
4+
title: "[FEATURE] "
5+
labels: "enhancement"
6+
assignees: ""
87
---
98

10-
**Is your feature request related to a problem? Please describe.**
9+
## Problem Description
10+
1111
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1212

13-
**Describe the solution you'd like**
13+
## Proposed Solution
14+
1415
A clear and concise description of what you want to happen.
1516

16-
**Describe alternatives you've considered**
17+
## Alternatives Considered
18+
1719
A clear and concise description of any alternative solutions or features you've considered.
1820

19-
**Additional context**
21+
## UI/UX Impact
22+
23+
How should this look or feel in the TUI? Any specific keyboard shortcuts or menu entries in mind?
24+
25+
## Additional Context
26+
2027
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Pull Request
2+
3+
> [!IMPORTANT]
4+
> All Pull Requests should target the **`develop`** branch.
5+
6+
## Description
7+
8+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
9+
10+
Fixes # (issue number)
11+
12+
## Type of change
13+
14+
- [ ] 🐛 Bug fix (non-breaking change which fixes an issue)
15+
- [ ] 🚀 New feature (non-breaking change which adds functionality)
16+
- [ ] 🛠️ Refactor (code improvement without functional changes)
17+
- [ ] 📖 Documentation update
18+
- [ ] 🧹 Maintenance (dependencies, CI, etc.)
19+
20+
## How Has This Been Tested?
21+
22+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
23+
24+
- [ ] Manual TUI verification
25+
- [ ] Automated tests (`bun test`)
26+
- [ ] Linting & Formatting (`bun check`)
27+
28+
## Screenshots (if applicable)
29+
30+
If your changes affect the UI, please provide screenshots or a short recording of the TUI.
31+
32+
## Checklist
33+
34+
- [ ] My PR targets the **`develop`** branch
35+
- [ ] My code follows the style guidelines of this project
36+
- [ ] I have performed a self-review of my own code
37+
- [ ] I have commented my code, particularly in hard-to-understand areas
38+
- [ ] I have made corresponding changes to the documentation
39+
- [ ] My changes generate no new warnings
40+
- [ ] I have added tests that prove my fix is effective or that my feature works
41+
- [ ] New and existing unit tests pass locally with my changes
42+
- [ ] Any dependent changes have been merged and published in downstream modules

‎CONTRIBUTING.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,15 @@ bun run migration:create my_migration_name
3939

4040
This creates `src/utils/migrations/{timestamp}_my_migration_name.ts` and registers it automatically.
4141

42+
## Branching Model
43+
44+
This project follows a branching model where development happens in the `develop` branch:
45+
46+
- **`main`**: Contains the latest stable release.
47+
- **`develop`**: The primary development branch. All feature branches should be created from and merged back into this branch.
48+
- **`feature/*`**: For new features and enhancements.
49+
- **`fix/*`**: For bug fixes.
50+
4251
## Pull Request Process
4352

4453
1. **Fork** the repository

0 commit comments

Comments
 (0)