Oxide Terminal / docs
Docs / Help / Contributing

Contributing

Oxide is one person's terminal, open to anyone who wants to make it better. The how-to lives in the repo; this page is the short version, and the credits.

How to contribute

CONTRIBUTING.md is the full guide: getting a build running on macOS and Linux, what a pull request needs, and the checklist for a user-visible change. The short version:

  • Bugs and small fixes — open a pull request. Anything bigger (a feature, a config option, a dependency), open an issue first so the shape is agreed before you write it.
  • One change per PR, with cargo test, cargo clippy --all-targets and cargo fmt clean, and a note on which platform(s) you tested.
  • A line in CHANGELOG.md under [Unreleased], written for users — it's what Help → What's New shows in the app. Add Contributed by <your handle> and you're credited in the release notes too.
  • Questions and ideas are welcome on the Discord.

There's one maintainer, so a review can take a few days. Pull requests are squash-merged; the merged commit keeps you as the author.

Contributors

People whose changes have shipped in Oxide, and what they built. Newest first.

  • agustux
    • bell = "sound" on Linux — plays the desktop's XDG sound theme through canberra-gtk-play, falling back to paplay, then to the visual flash. #4

Want to be on this list? The open items at the end of LINUX_PORT.md and the issue tracker are the places to look.