Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (33 loc) · 975 Bytes

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 975 Bytes

Contributing to loshell

Thanks for your interest in contributing.

Getting Started

  1. Fork the repo
  2. Clone your fork
  3. Create a branch: git checkout -b feat/your-feature
  4. Make your changes
  5. Run cargo fmt && cargo clippy
  6. Commit with a clear message
  7. Push and open a PR

Code Style

  • Run cargo fmt before committing
  • No clippy warnings
  • Keep it simple, avoid over-engineering
  • Follow existing patterns in the codebase

Commit Messages

Single line, short, direct. Use verbs like Add, Fix, Update, Remove.

Add station volume control
Fix pomodoro timer reset bug
Update README with new keybindings
Remove unused imports

Pull Requests

  • Keep PRs focused on a single change
  • Include a clear description of what and why
  • Link related issues if any

Issues

  • Check existing issues before opening a new one
  • Use the issue templates
  • Be specific about the problem or feature

Questions?

Open an issue or start a discussion.