Skip to content

Commit 6425518

Browse files
committed
Add contributing docs
1 parent 384cf75 commit 6425518

File tree

2 files changed

+27
-3
lines changed

2 files changed

+27
-3
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing
2+
3+
## Development
4+
5+
The plugin can be built with `./gradlew build`.
6+
7+
## Testing
8+
9+
Unit tests can be ran with `./gradlew test`.
10+
11+
Testing this in a live IDE requires loading it into a remote IDE launched via
12+
Gateway; one way is to use `scp` to copy it to the workspace then install it in
13+
the remote IDE as described in the readme.

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,18 @@ to using Coder through Gateway.
1111

1212
## Installation
1313

14-
- Manually:
14+
Download the [latest release](https://github.com/coder/jetbrains-backend-coder/releases/latest)
15+
and install it manually using <kbd>Settings/Preferences</kbd> > <kbd>Plugins
16+
<small>Host</small></kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from
17+
disk...</kbd>
1518

16-
Download the [latest release](https://github.com/coder/jetbrains-backend-coder/releases/latest) and install it manually using
17-
<kbd>Settings/Preferences</kbd> > <kbd>Plugins <small>Host</small></kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>
19+
Alternatively, you can add this plugin to your self-hosted marketplace if you
20+
have one. This plugin is not currently hosted on the public JetBrains
21+
marketplace.
22+
23+
Make sure to install it as a host plugin, not a client plugin.
24+
25+
## Features
26+
27+
- Scan `/proc/net/tcp*` files for listening ports and automatically forward
28+
them.

0 commit comments

Comments
 (0)