mirror of
https://github.com/soywod/himalaya.git
synced 2024-07-05 17:15:12 +00:00
509b09d533
Those commits have been stashed then applied due to merge issue: add ability to sync specific folders f7585eb add expunge command 1c0b7fb update readme links to documentation e1c8cf5 fix other doc typos 9c27165 reword title of the project 1eaac7d reword title of the project bis a7419d6 fix broken links in changelog 26b0311 prepare v0.7.1 2b5e58e
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
# Himalaya contributing guide
|
|
|
|
Thank you for investing your time in contributing to Himalaya!
|
|
|
|
## Development
|
|
|
|
The development environment is managed by
|
|
[Nix](https://nixos.org/download.html). Running `nix-shell` will spawn
|
|
a shell with everything you need to get started with the tool:
|
|
`cargo`, `cargo-watch`, `rust-bin`, `rust-analyzer`…
|
|
|
|
```sh
|
|
# starts a nix shell (the first launch may take a while)
|
|
$ nix-shell
|
|
|
|
# builds the CLI
|
|
$ cargo build
|
|
|
|
# runs the CLI
|
|
$ cargo run -- list
|
|
```
|
|
|
|
## Contributing
|
|
|
|
If you find a **bug**, please send an email at
|
|
[~soywod/pimalaya@todo.sr.ht](mailto:~soywod/pimalaya@todo.sr.ht).
|
|
|
|
If you have a **question**, please send an email at
|
|
[~soywod/pimalaya@lists.sr.ht](mailto:~soywod/pimalaya@lists.sr.ht).
|
|
|
|
If you want to **propose a feature** or **fix a bug**, please send a
|
|
patch at
|
|
[~soywod/pimalaya@lists.sr.ht](mailto:~soywod/pimalaya@lists.sr.ht)
|
|
using [git send-email](https://git-scm.com/docs/git-send-email) (see
|
|
[this guide](https://git-send-email.io/) on how to configure it).
|
|
|
|
If you want to **subscribe** to the mailing list, please send an email
|
|
at
|
|
[~soywod/pimalaya+subscribe@lists.sr.ht](mailto:~soywod/pimalaya+subscribe@lists.sr.ht).
|
|
|
|
If you want to **unsubscribe** to the mailing list, please send an
|
|
email at
|
|
[~soywod/pimalaya+unsubscribe@lists.sr.ht](mailto:~soywod/pimalaya+unsubscribe@lists.sr.ht).
|
|
|
|
If you want to **discuss** about the project, feel free to join the
|
|
[Matrix](https://matrix.org/) workspace
|
|
[#pimalaya.himalaya](https://matrix.to/#/#pimalaya.himalaya:matrix.org)
|
|
or contact me directly
|
|
[@soywod](https://matrix.to/#/@soywod:matrix.org).
|