github/television
1
1
Fork 0
mirror of https://github.com/alexpasmantier/television.git synced 2025-07-29 14:21:43 +00:00
Code Issues 1 Packages Projects Releases Wiki Activity

docs: update CONTRIBUTING.md

Browse Source
This commit is contained in:
alexandre pasmantier 2025-07-13 01:49:09 +02:00
parent 874e91190d
commit da9484a491
3 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -103,7 +103,9 @@ just test
Contributing a new channel is pretty straightforward. 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) 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/<os>/` (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 ## Hot Topics

4
docs/02-Developers/00-contributing.md
View File

@ -103,7 +103,9 @@ just test
Contributing a new channel is pretty straightforward. 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) 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/<os>/` (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 ## Hot Topics

10
justfile
View File

@ -96,17 +96,23 @@ update-man: build
else echo "No changes to manpages" else echo "No changes to manpages"
fi fi
publish: @publish:
echo "Publishing {{ NAME }}..." echo "Publishing {{ NAME }}..."
cargo publish --all-features cargo publish --all-features
echo "Done" echo "Done"
commit-release: @commit-release:
#!/usr/bin/env sh #!/usr/bin/env sh
version=$(grep -E '^\s*version\s*=' Cargo.toml | cut -d '"' -f 2) version=$(grep -E '^\s*version\s*=' Cargo.toml | cut -d '"' -f 2)
git commit -am "chore: release version $version" git commit -am "chore: release version $version"
git tag "$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 alias rl := release
# Publish a new release (major, minor, or patch) # Publish a new release (major, minor, or patch)
@release kind='patch': @release kind='patch':