Contributing

First of all, thanks for considering contributing to this project. All contributions are welcome, whether they are bug reports, documentation improvements, feature requests, or pull requests.

If you're not sure where to start, take a look at the Hot Topics section for some ideas on what you could work on.

Contributing to television's documentation website

To contribute to the docs, please refer to Contributing to docs. This will guide you through the process of setting up the documentation environment and making changes.

Getting started

Prerequisites

These are pretty much the only things you need to have installed on your machine to get started with contributing to this project:

the Rust toolchain installed on your machine
any working version of Git
the just command runner

Forking the repository and setting up the project

Click on the Fork button at the top right corner of the repository page to create a copy of the repository to your GitHub account.
Clone the forked repository to your local machine by running the following command in your terminal:
```
git clone https://github.com/<your-username>/television.git
```
Navigate to the project directory and set up the upstream remote by running the following commands:
```
cd television
git remote add upstream https://github.com/alexpasmantier/television.git
```
Install the project dependencies by running the following command:
```
just setup
```
Create a new branch for your feature or bug fix:
```
git checkout -b <branch-name>
```
Make your changes and test them locally. Predefined commands are available to make your life simpler, using them spares some time and effort:
```
just --list
```

Once you're all set, commit them to your branch:

git add .
git commit -m "Your commit message"

Push your changes to your forked repository:
```
git push origin <branch-name>
```
If not done automatically, create a pull request by navigating to the original repository and clicking on the New pull request button.

Developing locally

Before anything else (if not done already):

just setup

To run the application in debug mode while developing, with the ability to see logs and debug information:

just run

Accessing the Logs:

The logs are written to a file called television.log in a directory that depends on your operating system / configuration:

Platform	Location
Linux	`$XDG_DATA_HOME/television/television.log` or `$HOME/.local/share/television/television.log`
macOS	`$XDG_DATA_HOME/television/television.log` or `$HOME/Library/Application\ Support/television/television.log`
Windows	`{FOLDERID_LocalAppData}\television\television.log`

To check for linting and formatting issues (and fix them automatically), run:

just fix

To get a sense of the real thing and test how your patch would behave in production, run:

just b release

# or `just br`
# or `just build release`

Running the tests can be done with:

just test

Contributing a new channel

Contributing a new channel is pretty straightforward.

create a new branch, add and commit your new channel's TOML file under cable/unix (or cable/windows depending on your usecase)
push your commit and create a PR

Hot Topics

shell integration (autocomplete, keybindings)
packaging for various linux package managers (dnf, ...)
sorting options
ansi parsing
contributing new channels
improving code documentation

4.1 KiB Raw Blame History