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
• 💡 Suggest a feature — open an issue
• 💬 Share feedback — anything from UX nitpicks to "it broke on my terminal"
• ⭐ Star the repo — it genuinely helps
• 🍴 Fork and experiment — see Forks

🐛 Reporting bugs

Before reporting, please check existing issues to avoid duplicates.

When opening a bug report, 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:

  hn --debug
  

💡 Suggesting features

Open an issue 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

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 — free to use, study, fork, and redistribute.

---

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