29 lines
1.3 KiB
Markdown
29 lines
1.3 KiB
Markdown
# Getting Help
|
|
|
|
career-ops is an open source project maintained in limited time. Here's how to get help efficiently.
|
|
|
|
## Where to ask
|
|
|
|
| Question type | Where |
|
|
|---|---|
|
|
| **Bug** (something is broken) | [GitHub Issues](https://github.com/santifer/career-ops/issues) — use the Bug Report template |
|
|
| **Feature idea** | [GitHub Issues](https://github.com/santifer/career-ops/issues) — use the Feature Request template |
|
|
| **How do I...?** | [GitHub Discussions](https://github.com/santifer/career-ops/discussions) or [Discord](https://discord.gg/8pRpHETxa4) |
|
|
| **Setup help** | Check [docs/FAQ.md](docs/FAQ.md) for common questions, then [docs/SETUP.md](docs/SETUP.md), then ask in [Discord](https://discord.gg/8pRpHETxa4) |
|
|
| **Security vulnerability** | Email hi@santifer.io — see [SECURITY.md](SECURITY.md) |
|
|
|
|
## Before opening an issue
|
|
|
|
1. Search existing issues — someone may have reported it already
|
|
2. Run `npm run doctor` — it catches most setup problems
|
|
3. Include your OS, Node.js version, and the CLI you're using (Claude Code, OpenCode, etc.)
|
|
|
|
## What NOT to use GitHub Issues for
|
|
|
|
- General questions about job searching
|
|
- Requests for personal career advice
|
|
- Support for modified forks or unofficial distributions
|
|
- Asking the maintainer to review your CV
|
|
|
|
These will be closed and redirected to the appropriate channel.
|