Skip to content

Commit 4f5e4ce

Browse files
committed
Add contributing guidelines and issue templates
1 parent e60a3a1 commit 4f5e4ce

5 files changed

Lines changed: 97 additions & 35 deletions

File tree

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [arferreira]
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
name: Bug Report
3+
about: Something isn't working
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## What happened?
10+
11+
A clear description of the bug.
12+
13+
## Expected behavior
14+
15+
What should have happened.
16+
17+
## Steps to reproduce
18+
19+
1.
20+
2.
21+
3.
22+
23+
## Environment
24+
25+
- OS:
26+
- loshell version:
27+
- Install method (cargo/brew):
28+
29+
## Logs/Screenshots
30+
31+
If applicable.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## What problem does this solve?
10+
11+
Describe the use case.
12+
13+
## Proposed solution
14+
15+
How you think it should work.
16+
17+
## Alternatives considered
18+
19+
Other approaches you've thought about.
20+
21+
## Additional context
22+
23+
Anything else relevant.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Summary
2+
3+
What does this PR do?
4+
5+
## Related Issues
6+
7+
Closes #
8+
9+
## Checklist
10+
11+
- [ ] `cargo fmt` passes
12+
- [ ] `cargo clippy` has no warnings
13+
- [ ] Tested locally

CONTRIBUTING.md

Lines changed: 29 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,47 @@
11
# Contributing to loshell
22

3-
Thanks for wanting to help improve loshell.
3+
Thanks for your interest in contributing.
44

55
## Getting Started
66

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-
237
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
3114

3215
## Code Style
3316

3417
- 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
3721

38-
## Adding Stations
22+
## Commit Messages
3923

40-
Stations live in `src/radio.rs`. To add one:
24+
Single line, short, direct. Use verbs like Add, Fix, Update, Remove.
4125

42-
```rust
43-
Station {
44-
name: "Station Name",
45-
url: "https://direct-stream-url.mp3",
46-
},
4726
```
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
4840

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
5044

5145
## Questions?
5246

53-
Open an issue.
47+
Open an issue or start a discussion.

0 commit comments

Comments
 (0)