Skip to content

Commit

Permalink
docs(global): add contributing docs
Browse files Browse the repository at this point in the history
Also note that we're only support Deno at the moment.
  • Loading branch information
ajhalili2006 committed Jan 29, 2025
1 parent b5fac1d commit 80dec57
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contributing guidelines

Thanks for your interest in extending the CLI's feature set! Although it is
small at the moment (and relatively feature complete for now), we are open for
patches related to bug fixes and porting to other runtimes.

## Preflight checklist

* Agree to the [community code of conduct](https://policies.recaptime.dev/code-of-conduct)
and [the Linux DCO](https://developercertificate.org/).

## Prerequisites for CLI dev

* [Deno](https://deno.com) (v2.x preferred)
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ instead of [`npm:commander`](https://npmjs.com/package/commander).

## Install

> **Note**: Currently works only on Deno for now, but feel free to contribute patches
> for npm and bun support
Requires Tailscale to be installed and authenicated with MagicDNS enabled
if you want to use the default base URL.

Expand Down

0 comments on commit 80dec57

Please sign in to comment.