Skip to content

Commit fb83d53

Browse files
Bittu-the-coderBittu-the-coder
committed
Add GitHub Pages website and cleanup docs
1 parent 8ca05b3 commit fb83d53

10 files changed

Lines changed: 1532 additions & 25 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Bug Report
3+
about: Report a bug or issue with WhatsApp Lite
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+
1. Go to '...'
16+
2. Click on '...'
17+
3. Scroll down to '...'
18+
4. See error
19+
20+
## ✅ Expected Behavior
21+
22+
<!-- What you expected to happen -->
23+
24+
## ❌ Actual Behavior
25+
26+
<!-- What actually happened -->
27+
28+
## 📸 Screenshots
29+
30+
<!-- If applicable, add screenshots to help explain your problem -->
31+
32+
## 💻 System Information
33+
34+
- **OS**: Windows [e.g. Windows 11 22H2]
35+
- **WhatsApp Lite Version**: [e.g. v1.0.0]
36+
- **Installation Method**: [Installer / Built from source]
37+
38+
## 📝 Additional Context
39+
40+
<!-- Add any other context about the problem here -->
41+
42+
## 🔍 Console Errors (if applicable)
43+
44+
<!-- Open Developer Tools and paste any error messages -->
45+
46+
```
47+
Paste console errors here
48+
```
49+
50+
---
51+
52+
**Before submitting:**
53+
54+
- [ ] I've searched existing issues to avoid duplicates
55+
- [ ] I've included all relevant information above
56+
- [ ] I've tested on the latest version

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new feature or enhancement for WhatsApp Lite
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## 🚀 Feature Description
10+
11+
<!-- A clear and concise description of what you want to happen -->
12+
13+
## 💡 Why This Feature?
14+
15+
<!-- Explain the problem this feature solves or the value it adds -->
16+
17+
## 📝 Proposed Solution
18+
19+
<!-- Describe how you envision this feature working -->
20+
21+
## 🔄 Alternatives Considered
22+
23+
<!-- Have you considered any alternative solutions or features? -->
24+
25+
## 📊 Use Cases
26+
27+
<!-- Provide examples of how this feature would be used -->
28+
29+
1.
30+
2.
31+
3.
32+
33+
## 🎨 Mockups/Examples (optional)
34+
35+
<!-- Add any mockups, screenshots, or examples from other apps -->
36+
37+
## 📈 Priority (your opinion)
38+
39+
<!-- How important is this feature to you? -->
40+
41+
- [ ] Critical - blocking my usage
42+
- [ ] High - significantly improves experience
43+
- [ ] Medium - nice to have
44+
- [ ] Low - minor improvement
45+
46+
## 📝 Additional Context
47+
48+
<!-- Add any other context or details about the feature request -->
49+
50+
---
51+
52+
**Before submitting:**
53+
54+
- [ ] I've searched existing feature requests to avoid duplicates
55+
- [ ] This feature aligns with the lightweight/privacy-focused goals
56+
- [ ] I've provided clear use cases

‎.github/workflows/deploy.yml‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Deploy GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: 'pages'
15+
cancel-in-progress: false
16+
17+
jobs:
18+
deploy:
19+
environment:
20+
name: github-pages
21+
url: ${{ steps.deployment.outputs.page_url }}
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Pages
28+
uses: actions/configure-pages@v4
29+
30+
- name: Upload artifact
31+
uses: actions/upload-pages-artifact@v3
32+
with:
33+
path: './docs'
34+
35+
- name: Deploy to GitHub Pages
36+
id: deployment
37+
uses: actions/deploy-pages@v4

‎CONTRIBUTING.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Contributing to WhatsApp Lite
2+
3+
Thank you for considering contributing to **WhatsApp Lite** - the lightweight, privacy-focused WhatsApp desktop client! We welcome all contributions that help improve this open-source project.
4+
5+
## 🎯 How to Contribute
6+
7+
### Reporting Bugs
8+
9+
1. Check if the bug has already been reported in [Issues](https://github.com/bittu-the-coder/whatsapp-lite/issues)
10+
2. Create a new issue with:
11+
- Clear, descriptive title
12+
- Steps to reproduce
13+
- Expected vs actual behavior
14+
- Screenshots if applicable
15+
- System information (Windows version, app version)
16+
17+
### Suggesting Features
18+
19+
1. Check [existing feature requests](https://github.com/bittu-the-coder/whatsapp-lite/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement)
20+
2. Create a new issue with:
21+
- Clear description of the feature
22+
- Use cases and benefits
23+
- Possible implementation approach
24+
25+
### Code Contributions
26+
27+
#### Setup Development Environment
28+
29+
```bash
30+
# Fork the repository on GitHub
31+
# Clone your fork
32+
git clone https://github.com/YOUR_USERNAME/whatsapp-lite.git
33+
cd whatsapp-lite
34+
35+
# Add upstream remote
36+
git remote add upstream https://github.com/bittu-the-coder/whatsapp-lite.git
37+
38+
# Install dependencies
39+
npm install
40+
41+
# Run in development mode
42+
npm run tauri dev
43+
```
44+
45+
#### Making Changes
46+
47+
1. Create a feature branch: `git checkout -b feature/your-feature-name`
48+
2. Make your changes following our coding standards
49+
3. Test your changes thoroughly
50+
4. Commit with clear, descriptive messages
51+
5. Push to your fork: `git push origin feature/your-feature-name`
52+
6. Open a Pull Request
53+
54+
#### Pull Request Guidelines
55+
56+
- Reference any related issues
57+
- Provide clear description of changes
58+
- Include screenshots for UI changes
59+
- Ensure code builds without errors
60+
- Update documentation if needed
61+
62+
## 💻 Development Guidelines
63+
64+
### Code Style
65+
66+
- **Rust**: Follow [Rust API Guidelines](https://rust-lang.github.io/api-guidelines/)
67+
- **JavaScript**: Use ES6+ features, clear variable names
68+
- **Comments**: Explain "why", not "what"
69+
70+
### Commit Messages
71+
72+
```
73+
feat: Add system notification preferences
74+
fix: Resolve system tray icon not showing on startup
75+
docs: Update installation instructions
76+
style: Format code according to prettier config
77+
refactor: Improve window management logic
78+
test: Add unit tests for tray menu
79+
```
80+
81+
### Testing
82+
83+
- Test on Windows 10 and 11
84+
- Verify system tray functionality
85+
- Check UI responsiveness
86+
- Ensure no performance regressions
87+
88+
## 📖 Resources
89+
90+
- [Tauri Documentation](https://tauri.app/v2/guides/)
91+
- [Rust Book](https://doc.rust-lang.org/book/)
92+
- [Project Architecture](docs/ARCHITECTURE.md) (if available)
93+
94+
## 🤝 Code of Conduct
95+
96+
- Be respectful and inclusive
97+
- Focus on constructive feedback
98+
- Help others in the community
99+
- Maintain professional communication
100+
101+
## 📝 License
102+
103+
By contributing, you agree that your contributions will be licensed under the MIT License.
104+
105+
---
106+
107+
**Questions?** Open a [GitHub Discussion](https://github.com/bittu-the-coder/whatsapp-lite/discussions) or comment on an issue!

0 commit comments

Comments
 (0)