Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (79 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

110 lines (79 loc) · 3.35 KB
Raw

Contributing

Contributing to InputPlumber is done via Pull Requests on the main github repository: InputPlumber.

Commit Titles

This project uses semantic-release which uses Angular-style commit messages in order to automatically trigger releases.

You can read more about it here.

In short every commit must be in the form of:

  • chore(thing): Title words
  • fix(thing): Title words
  • feat(thing): Title words
  • docs(thing): Title words

This is a non-exhaustive list, please read the above link to learn more.

General Rules

Files related to IDEs are not allowed in the repository.

Every commit must go through

cargo fmt

so make sure to run it before any new commit.

AI/Tool-generated Content

Contributions authored using code generation tools like large language models may be accepted, but must be clearly disclosed as part of the commit message(s) that contain generated code and you must be prepared to explain every line that was generated. Contributions submitted that used generated content without disclosure may be rejected without review. Accepted code may be reverted if AI tools were discovered to have been used after inclusion and users found to be flagrantly violating this policy after a warning are subject to a ban from the project.

You can disclose tool use by including something like this in the body of your commit message:

Co-developed-by: Claude Opus 4.6

You should also elaborate on which parts were generated, what prompts you used, etc.

Before submitting your PR, you must ensure that you have fully reviewed the changes you submit.

Using AI to respond to human reviewers is strictly prohibited.

Testing and debugging

In order to run the application you have to stop every other running instances and launch as the in-development version as root: this can be achieved launching lldb-server as root and connecting to that service to debug InputPlumber.

The command is the following:

lldb-server platform --listen "*:1234" --server

if you want to use a systemd service:

[Unit]
Description=lldb debug server
Wants=network-online.target
After=network.target network-online.target

[Service]
ExecStart=lldb-server platform --listen "*:1234" --server
Restart=always
WorkingDirectory=/var/lldb-debug-server

[Install]
WantedBy=multi-user.target

however remember to disable it when you are done and to be on a secure network as no password will be asked and every executable sent will be run as root.

A minimal configuration for VSCode with CodeLLDB extension to match the previous command is as follows:

{
    
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Remote launch",
            "type": "lldb",
            "request": "launch",
            "program": "${workspaceFolder}/target/debug/inputplumber",
            "initCommands": [
                "platform select remote-linux",
                "platform connect connect://192.168.1.19:1234",
                "settings set target.inherit-env false"
            ],
            "env": {
                "PATH": "/usr/bin:/usr/local/sbin:/usr/local/bin:/var/lib/flatpak/exports/bin:/usr/lib/rustup/bin"
            }
        }
    ]
}