# Contributing to hn

First off, thank you for your interest in the project! 💛

This project is maintained in my spare time, and I currently do not have enough capacity to properly review external pull requests. Issues, bug reports, feature suggestions, and general feedback are very welcome — and I read every one.

## Ways to contribute

- 🐛 **Report a bug** — [open an issue](https://github.com/heartleo/hn-cli/issues/new)
- 💡 **Suggest a feature** — [open an issue](https://github.com/heartleo/hn-cli/issues/new)
- 💬 **Share feedback** — anything from UX nitpicks to "it broke on my terminal"
- ⭐ **Star the repo** — it genuinely helps
- 🍴 **Fork and experiment** — see [Forks](#-forks)

## 🐛 Reporting bugs

Before reporting, please check [existing issues](https://github.com/heartleo/hn-cli/issues) to avoid duplicates.

When [opening a bug report](https://github.com/heartleo/hn-cli/issues/new), please include:

- **Environment** — your OS and terminal (e.g. macOS + iTerm2, Windows + Windows Terminal)
- **Version** — output of `hn version`
- **Steps to reproduce** — what you did, what you expected, and what happened instead
- **Debug log** — if relevant, attach the `debug.log` produced by:

  ```bash
  hn --debug
  ```

## 💡 Suggesting features

[Open an issue](https://github.com/heartleo/hn-cli/issues/new) describing the **problem you're trying to solve**, not just the solution you have in mind. Ideas that fit the project's goal — a fast, keyboard-driven HN reader for the terminal — are most likely to land.

## 🔀 Pull requests

> [!IMPORTANT]
> This repository does not accept pull requests at this time.

It's not that your code isn't wanted — reviewing, testing, and maintaining external changes responsibly takes more time than I can commit to right now. Please share your ideas as issues instead.

## 🍴 Forks

Forking is encouraged — that's the spirit of open source. If you've built something interesting on a fork, link it in an issue; I'd love to see it.

## 📄 License

The code is and will remain open source under the [MIT License](LICENSE) — free to use, study, fork, and redistribute.

---

Thank you for your understanding and interest in the project. 🧡