Peter Schilling
e8a7cd4668
The issue tracker occasionally gets unsolicited issues promoting the author's own npm package rather than reporting a problem with linear-cli. State the tracker's scope up front so closing those cites a rule instead of an ad-hoc judgment call. Issue forms replace free-form issues: their required problem and reproduction fields are the friction that actually helps, by asking for the thing a promotional issue does not have. Usage questions route to Discussions; nothing routes package promotion anywhere.
1.1 KiB
Contributing
Scope of the issue tracker
Issues are for bugs and feature requests in linear-cli, filed by people using it. Questions about installing, configuring, or using it belong in Discussions.
Do not open issues recommending that linear-cli adopt a library you maintain or are affiliated with. These are closed without discussion.
If you hit a problem using linear-cli that a dependency would solve, file the problem. Naming a library as part of that is fine, but the issue needs to be about the problem you hit, not the library.
Issues outside this scope may be closed.
Development
linear-cli is written in TypeScript and runs on Deno.
deno task test # run the test suite
deno task validate # type check, format, lint
deno task snapshot # update snapshot tests
After editing a GraphQL document, run deno task codegen to regenerate types.
Pull requests
Keep changes focused, and add tests for new behavior. Tests mirror the source layout: src/commands/issue/issue-view.ts is tested by test/commands/issue/issue-view.test.ts.