|
| 1 | +# Contributing to gmtui |
| 2 | + |
| 3 | +Thanks for taking the time to contribute. I maintain `gmtui` for daily use, so changes need to be fast, reliable, and easy to reason about. If that matches your goals, welcome. |
| 4 | + |
| 5 | +## Principles |
| 6 | + |
| 7 | +- Keep the UI fast and keyboard-first. |
| 8 | +- Minimize Gmail API calls and respect rate limits. |
| 9 | +- Prefer explicit errors over silent recovery. |
| 10 | +- Avoid adding new dependencies without prior discussion. |
| 11 | + |
| 12 | +## Code Style |
| 13 | + |
| 14 | +- Keep modules focused and cohesive. |
| 15 | +- Use `Result<T, GmtuiError>` for fallible logic. |
| 16 | +- Avoid `unwrap()` and `expect()` outside `main.rs`. |
| 17 | +- Add tests for logic changes when practical. |
| 18 | + |
| 19 | +## Commit Messages |
| 20 | + |
| 21 | +Use Conventional Commits: |
| 22 | + |
| 23 | +- `feat: add threaded view` |
| 24 | +- `fix: handle empty payload body` |
| 25 | +- `docs: clarify OAuth setup` |
| 26 | + |
| 27 | +## Running Tests |
| 28 | + |
| 29 | +```bash |
| 30 | +cargo test --all |
| 31 | +``` |
| 32 | + |
| 33 | +Formatting and linting: |
| 34 | + |
| 35 | +```bash |
| 36 | +cargo fmt |
| 37 | +cargo clippy --all-targets -- -D warnings |
| 38 | +``` |
| 39 | + |
| 40 | +## Pull Requests |
| 41 | + |
| 42 | +- Open an issue for UX or API changes first. |
| 43 | +- Keep PRs small and focused. |
| 44 | +- Describe behavior changes clearly. |
| 45 | +- Include tests or explain why they’re not feasible. |
| 46 | + |
| 47 | +## Issue Triage |
| 48 | + |
| 49 | +- Bugs: include steps to reproduce and expected vs actual results. |
| 50 | +- Features: explain the user story and tradeoffs. |
| 51 | +- Performance: include measurements where possible. |
| 52 | + |
| 53 | +## License |
| 54 | + |
| 55 | +By contributing, you agree that your work is released under the MIT License. |
| 56 | + |
| 57 | +Name: Soumalya Das |
| 58 | +Email: geniussantu1983@gmail.com |
| 59 | +GitHub: https://github.com/pro-grammer-SD |
| 60 | +Repo: https://github.com/pro-grammer-SD/gmtui |
0 commit comments