mirror of
https://github.com/alexpasmantier/television.git
synced 2025-07-28 22:01:39 +00:00
docs: update CONTRIBUTING.md
This commit is contained in:
parent
874e91190d
commit
da9484a491
@ -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/<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
|
||||
|
||||
|
@ -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/<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
|
||||
|
||||
|
10
justfile
10
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':
|
||||
|
Loading…
x
Reference in New Issue
Block a user