Contributors guide

If you're interested in contributing to XPipe, you can easily do so! Just submit a pull request with your changes.

In terms of development environment setup, be sure to read the development page first. Especially when starting out, it might be a good idea to start with easy tasks first. Here's a selection of suitable common tasks that are very easy to implement:

Implementing support for a new editor

All code for handling external editors can be found here. There you will find plenty of working examples that you can use as a base for your own implementation.

Implementing support for a new terminal

All code for handling external terminals can be found here. There you will find plenty of working examples that you can use as a base for your own implementation.

Adding more file icons for specific types

You can register file types here and add the respective icons here.

The existing file list and icons are taken from the vscode-icons project. Due to limitations in the file definition list compatibility, some file types might not be listed by their proper extension and are therefore not being applied correctly even though the images and definitions exist already.

In case you want to implement your own actions for certain file types in the file browser, you can easily do so. You can find most existing actions here to get some inspiration. Once you created your custom classes, you have to register them in your module info, just like here.

Implementing custom actions for the connection hub

All actions that you can perform for certain connections in the connection overview tab are implemented using an Action API. You can find a sample implementation here and many common action implementations here.

Familiarising yourself with the shell and command API

The sample action shows the basics of working with shells and executing commands in them. For more references, just look for the usages of the API classes.

Implementing something else

if you want to work on something that was not listed here, you can still do so of course. You can reach out on the Discord server to discuss any development plans and get you started.

3.5 KiB Raw Blame History