Skip to content

Commit 2958fea

Browse files
authored
docs: streamline README and extract CONTRIBUTING.md (#51)
- Reduce README from 491 to 285 lines (42% less) - Remove duplicated sections (Usage Tips, Support & Contact) - Move dev setup, code standards, PR process to CONTRIBUTING.md - Replace What's New with link to CHANGELOG_USER.md - Trim Features section (remove dev jargon, condense parental controls) - Replace MPV keyboard table with link to MPV docs - Remove static tests-passing badge - Move legal disclaimer to prominent position - Clean up marketing language
1 parent 5287d55 commit 2958fea

2 files changed

Lines changed: 139 additions & 239 deletions

File tree

CONTRIBUTING.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Contributing to Better IPTV
2+
3+
## Report Bugs
4+
5+
[Create an issue](https://github.com/mewset/better-iptv/issues/new) with:
6+
- Detailed description
7+
- Steps to reproduce
8+
- OS and app version
9+
- Screenshots if applicable
10+
- Log file (see [Troubleshooting](README.md#%EF%B8%8F-troubleshooting))
11+
12+
## Suggest Features
13+
14+
[Open a feature request](https://github.com/mewset/better-iptv/issues/new) describing:
15+
- What you want
16+
- Why it's useful
17+
- How it should work
18+
19+
## Development Setup
20+
21+
```bash
22+
# Fork & clone
23+
git clone https://github.com/YOUR-USERNAME/better-iptv.git
24+
cd better-iptv
25+
26+
# Install dependencies
27+
npm install
28+
29+
# Run dev server
30+
npm run tauri dev
31+
32+
# Run tests
33+
npm run test # Frontend tests
34+
cd src-tauri && cargo test # Rust tests
35+
```
36+
37+
### Build from Source
38+
39+
```bash
40+
npm run tauri build
41+
# Output: src-tauri/target/release/bundle/
42+
```
43+
44+
## Code Standards
45+
46+
- **TypeScript**: Follow ESLint config (`npm run lint`)
47+
- **Rust**: Use `rustfmt` and `clippy`
48+
```bash
49+
cargo fmt
50+
cargo clippy
51+
```
52+
- **Commits**: Use [Conventional Commits](https://www.conventionalcommits.org/)
53+
```
54+
feat: add category quick-access bar
55+
fix: resolve EPG timezone bug
56+
docs: update README installation steps
57+
```
58+
59+
## Pull Request Process
60+
61+
1. Create feature branch: `git checkout -b feature/my-feature`
62+
2. Make changes with tests
63+
3. Run linters: `npm run lint && cargo clippy`
64+
4. Commit: `git commit -m "feat: description"`
65+
5. Push: `git push origin feature/my-feature`
66+
6. Open PR on GitHub with detailed description
67+
68+
## Community Guidelines
69+
70+
- Be respectful and inclusive
71+
- Provide constructive feedback
72+
- Help other users in issues/discussions
73+
- Document your changes clearly

0 commit comments

Comments
 (0)