doknyudocs

Contribuindo

Como compilar, testar e enviar mudanças para o doknyu.

Contribuições são bem-vindas: código, traduções, testes em outras distros e bugs bem descritos.

Ambiente

Rust 1.89 ou mais novo. No Ubuntu/Debian:

sudo apt install libxkbcommon-dev libwayland-dev libvulkan-dev pkg-config
git clone https://github.com/RafaelProfMgz/doknyu
cd doknyu

Comandos do dia a dia

cargo run                    # precisa de um daemon do Docker rodando
cargo run --features fake    # cliente falso em memória, sem Docker
cargo fmt --check
cargo clippy --all-targets -- -D warnings
cargo test
cargo test -- --ignored      # testes de integração, precisam de Docker

Antes de abrir um pull request, rode fmt, clippy e test.

Textos e traduções

Todo texto visível passa por t!("chave"), com entradas em locales/en.yml e locales/pt-BR.yml. Ao adicionar um texto, inclua a chave nos dois arquivos. Quer traduzir para outro idioma? Crie um novo arquivo em locales/ e abra um PR.

Pacotes

cargo build --release
cargo install cargo-deb --locked && cargo deb --no-build   # target/debian/*.deb
packaging/appimage/build-appimage.sh                       # target/appimage/*.AppImage

As releases são geradas pelo GitHub Actions quando uma tag v* é enviada. Os arquivos de Flatpak, AUR, COPR e Nix ficam em packaging/.

Reportando bugs

Abra uma issue com:

  • versão do doknyu e formato (.deb, AppImage, código-fonte);
  • distro, versão e ambiente gráfico (Wayland ou X11);
  • versão do Docker (docker version);
  • passos para reproduzir e o que você esperava.

Logs detalhados ajudam muito:

RUST_LOG=debug doknyu

Antes de colar logs, confira se não há nomes, variáveis de ambiente ou dados que você não queira tornar públicos.

Nesta página