|
1 | 1 | # Contributing to loshell |
2 | 2 |
|
3 | | -Thanks for wanting to help improve loshell. |
| 3 | +Thanks for your interest in contributing. |
4 | 4 |
|
5 | 5 | ## Getting Started |
6 | 6 |
|
7 | | -```bash |
8 | | -git clone https://github.com/arferreira/loshell.git |
9 | | -cd loshell |
10 | | -cargo run |
11 | | -``` |
12 | | - |
13 | | -## What We're Looking For |
14 | | - |
15 | | -- New radio stations (must be direct HTTP streams, no YouTube) |
16 | | -- UI improvements (keeping it minimal) |
17 | | -- Bug fixes |
18 | | -- Performance improvements |
19 | | -- Platform support (Windows, etc.) |
20 | | - |
21 | | -## Pull Requests |
22 | | - |
23 | 7 | 1. Fork the repo |
24 | | -2. Create a branch (`git checkout -b feature/your-thing`) |
25 | | -3. Make your changes |
26 | | -4. Run `cargo fmt` and `cargo clippy` |
27 | | -5. Commit with a clear message |
28 | | -6. Push and open a PR |
29 | | - |
30 | | -Keep PRs focused. One feature or fix per PR. |
| 8 | +2. Clone your fork |
| 9 | +3. Create a branch: `git checkout -b feat/your-feature` |
| 10 | +4. Make your changes |
| 11 | +5. Run `cargo fmt && cargo clippy` |
| 12 | +6. Commit with a clear message |
| 13 | +7. Push and open a PR |
31 | 14 |
|
32 | 15 | ## Code Style |
33 | 16 |
|
34 | 17 | - Run `cargo fmt` before committing |
35 | | -- No warnings from `cargo clippy` |
36 | | -- Keep it simple - this is a small focused tool |
| 18 | +- No clippy warnings |
| 19 | +- Keep it simple, avoid over-engineering |
| 20 | +- Follow existing patterns in the codebase |
37 | 21 |
|
38 | | -## Adding Stations |
| 22 | +## Commit Messages |
39 | 23 |
|
40 | | -Stations live in `src/radio.rs`. To add one: |
| 24 | +Single line, short, direct. Use verbs like Add, Fix, Update, Remove. |
41 | 25 |
|
42 | | -```rust |
43 | | -Station { |
44 | | - name: "Station Name", |
45 | | - url: "https://direct-stream-url.mp3", |
46 | | -}, |
47 | 26 | ``` |
| 27 | +Add station volume control |
| 28 | +Fix pomodoro timer reset bug |
| 29 | +Update README with new keybindings |
| 30 | +Remove unused imports |
| 31 | +``` |
| 32 | + |
| 33 | +## Pull Requests |
| 34 | + |
| 35 | +- Keep PRs focused on a single change |
| 36 | +- Include a clear description of what and why |
| 37 | +- Link related issues if any |
| 38 | + |
| 39 | +## Issues |
48 | 40 |
|
49 | | -Make sure the stream is reliable and publicly accessible. |
| 41 | +- Check existing issues before opening a new one |
| 42 | +- Use the issue templates |
| 43 | +- Be specific about the problem or feature |
50 | 44 |
|
51 | 45 | ## Questions? |
52 | 46 |
|
53 | | -Open an issue. |
| 47 | +Open an issue or start a discussion. |
0 commit comments