From da9484a4912b93353c970ed25728a9140f6a0f51 Mon Sep 17 00:00:00 2001 From: alexandre pasmantier Date: Sun, 13 Jul 2025 01:49:09 +0200 Subject: [PATCH] docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 4 +++- docs/02-Developers/00-contributing.md | 4 +++- justfile | 10 ++++++++-- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9c76839..d81a521 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -103,7 +103,9 @@ just test Contributing a new channel is pretty straightforward. 1. create a new branch, add and commit your new channel's TOML file under `cable/unix` (or `cable/windows` depending on your usecase) -2. push your commit and create a PR +2. [optional] add a screenshot of the channel in `assets/channels//` (e.g. `assets/channels/unix/my_channel.png`). +3. push your commit and create a PR +4. the ci will automatically generate the documentation for your channel and pick up the screenshot if available. ## Hot Topics diff --git a/docs/02-Developers/00-contributing.md b/docs/02-Developers/00-contributing.md index 9c76839..d81a521 100644 --- a/docs/02-Developers/00-contributing.md +++ b/docs/02-Developers/00-contributing.md @@ -103,7 +103,9 @@ just test Contributing a new channel is pretty straightforward. 1. create a new branch, add and commit your new channel's TOML file under `cable/unix` (or `cable/windows` depending on your usecase) -2. push your commit and create a PR +2. [optional] add a screenshot of the channel in `assets/channels//` (e.g. `assets/channels/unix/my_channel.png`). +3. push your commit and create a PR +4. the ci will automatically generate the documentation for your channel and pick up the screenshot if available. ## Hot Topics diff --git a/justfile b/justfile index ec9ba68..f42da33 100644 --- a/justfile +++ b/justfile @@ -96,17 +96,23 @@ update-man: build else echo "No changes to manpages" fi -publish: +@publish: echo "Publishing {{ NAME }}..." cargo publish --all-features echo "Done" -commit-release: +@commit-release: #!/usr/bin/env sh version=$(grep -E '^\s*version\s*=' Cargo.toml | cut -d '"' -f 2) git commit -am "chore: release version $version" git tag "$version" +@push-release: + #!/usr/bin/env sh + echo "Pushing changes and tags to remote..." + git push origin main --tags + echo "Done" + alias rl := release # Publish a new release (major, minor, or patch) @release kind='patch':