Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
84 lines (51 loc) · 3.58 KB

CONTRIBUTING.md

File metadata and controls

84 lines (51 loc) · 3.58 KB

Contributing to NoSuckShell

Thanks for your interest in improving NoSuckShell. This repository is a small monorepo: the product is the Tauri 2 desktop app under apps/desktop (React + Vite frontend, Rust backend).

Prerequisites

  • Node.js and npm (versions aligned with what you use for local development).
  • Rust (stable toolchain) and Cargo.
  • Tauri prerequisites for your OS: Tauri prerequisites.

Getting started

Clone the repository, then from the repository root:

npm run desktop:install
npm run tauri:dev

On Linux Wayland, the binary applies the same WEBKIT_DISABLE_DMABUF_RENDERER default as in the root README.md unless you already set that variable. Override it in your environment if you need different behavior.

You can also work from apps/desktop directly (npm install, npm run tauri:dev); the root scripts ensure dependencies are present when you use the root commands.

Arch Linux package (install / local makepkg)

AUR: yay -S nosuckshell-bin — see aur/README.md and aur/nosuckshell-bin/PKGBUILD.

Releases may also include nosuckshell-….pkg.tar.zst. Installing from GitHub and building the same repackage locally after tauri:build (with pkgver set in PKGBUILD) is documented under Arch Linux / CachyOS (manual) in the root README.md Install section.

Maintainers: After a GitHub Release is published, .github/workflows/aur-publish.yml can push updates to the AUR when the AUR_SSH_PRIVATE_KEY repository secret is configured (see aur/README.md).

Local Flatpak (Linux)

To build a single-file .flatpak from the Tauri .deb and install it with flatpak --user install --bundle, see flatpak/README.md and run bash scripts/build-local-flatpak.sh from the repository root.

Style and code

Marketing screenshots

To regenerate README / store PNGs (Playwright + stubbed Tauri IPC), from the repository root:

npm run screenshots

Details: docs/media/screenshots/README.md.

Validate your changes

From apps/desktop (see also the root README):

npm test
npm run build
cd src-tauri
cargo test
cargo check

Pull requests

  • Keep changes focused on the problem or feature you are addressing.
  • Add or update tests when behavior changes or new logic deserves coverage.
  • Avoid drive-by refactors or unrelated formatting churn in the same PR.

Use the checklist in .github/pull_request_template.md when you open a PR.

For security-sensitive reports, use the process in SECURITY.md, not a public issue.

Releases (maintainers)

Process and tagging: docs/releases.md. User-facing notes: docs/CHANGELOG.md. Checklist (versions, lockfiles, doc sync): .agents/skills/nosuckshell_ops/SKILL.md § Release preparation.

Community standards

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold it.

License

By contributing, you agree that your contributions will be licensed under the same terms as the project (MIT).