mirror of
https://github.com/alexpasmantier/television.git
synced 2025-07-29 06:11:37 +00:00
docs: add links to various repo docs
This commit is contained in:
parent
fb97f011be
commit
f0d17b7011
@ -2,13 +2,11 @@
|
||||
|
||||
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.
|
||||
|
||||
Please make sure to read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a positive experience for everyone involved.
|
||||
|
||||
If you're not sure where to start, take a look at the [Hot Topics](#hot-topics) section for some ideas on what you could work on.
|
||||
|
||||
# Docs contributing
|
||||
# Contributing to television's documentation website
|
||||
|
||||
To contribute to the docs, please refer to [Contributing to Docs](website/CONTRIBUTING.md) in the `website` directory. This will guide you through the process of setting up the documentation environment and making changes.
|
||||
To contribute to the docs, please refer to [Contributing to docs](https://github.com/alexpasmantier/television/blob/main/website/CONTRIBUTING.md). This will guide you through the process of setting up the documentation environment and making changes.
|
||||
|
||||
## Getting started
|
||||
|
||||
@ -35,7 +33,7 @@ These are pretty much the only things you need to have installed on your machine
|
||||
4. Install the project dependencies by running the following command:
|
||||
```shell
|
||||
just setup
|
||||
```
|
||||
```
|
||||
5. Create a new branch for your feature or bug fix:
|
||||
```shell
|
||||
git checkout -b <branch-name>
|
||||
@ -49,11 +47,11 @@ These are pretty much the only things you need to have installed on your machine
|
||||
git add .
|
||||
git commit -m "Your commit message"
|
||||
```
|
||||
7. Push your changes to your forked repository:
|
||||
8. Push your changes to your forked repository:
|
||||
```shell
|
||||
git push origin <branch-name>
|
||||
```
|
||||
8. If not done automatically, create a pull request by navigating to the original repository and clicking on the `New pull request` button.
|
||||
9. If not done automatically, create a pull request by navigating to the original repository and clicking on the `New pull request` button.
|
||||
|
||||
### Developing locally
|
||||
|
||||
@ -73,11 +71,11 @@ just run
|
||||
|
||||
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` |
|
||||
| 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:
|
||||
|
||||
@ -90,11 +88,12 @@ To get a sense of the real thing and test how your patch would behave in product
|
||||
```shell
|
||||
just b release
|
||||
|
||||
# or `just br`
|
||||
# or `just br`
|
||||
# or `just build release`
|
||||
```
|
||||
|
||||
Running the tests can be done with:
|
||||
|
||||
```shell
|
||||
just test
|
||||
```
|
||||
@ -102,6 +101,7 @@ just test
|
||||
### Contributing a new channel
|
||||
|
||||
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
|
||||
|
||||
@ -113,6 +113,3 @@ Contributing a new channel is pretty straightforward.
|
||||
- ansi parsing
|
||||
- contributing new channels
|
||||
- improving code documentation
|
||||
|
||||
|
||||
|
||||
|
115
docs/02-Developers/00-contributing.md
Normal file
115
docs/02-Developers/00-contributing.md
Normal file
@ -0,0 +1,115 @@
|
||||
# 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](#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](https://github.com/alexpasmantier/television/blob/main/website/CONTRIBUTING.md). 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](https://www.rust-lang.org/tools/install) toolchain installed on your machine
|
||||
- any working version of [Git](https://git-scm.com/downloads)
|
||||
- the [just](https://github.com/casey/just) command runner
|
||||
|
||||
### Forking the repository and setting up the project
|
||||
|
||||
1. 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.
|
||||
2. Clone the forked repository to your local machine by running the following command in your terminal:
|
||||
```shell
|
||||
git clone https://github.com/<your-username>/television.git
|
||||
```
|
||||
3. Navigate to the project directory and set up the upstream remote by running the following commands:
|
||||
```shell
|
||||
cd television
|
||||
git remote add upstream https://github.com/alexpasmantier/television.git
|
||||
```
|
||||
4. Install the project dependencies by running the following command:
|
||||
```shell
|
||||
just setup
|
||||
```
|
||||
5. Create a new branch for your feature or bug fix:
|
||||
```shell
|
||||
git checkout -b <branch-name>
|
||||
```
|
||||
6. Make your changes and test them locally. Predefined commands are available to make your life simpler, using them spares some time and effort:
|
||||
```shell
|
||||
just --list
|
||||
```
|
||||
7. Once you're all set, commit them to your branch:
|
||||
```shell
|
||||
git add .
|
||||
git commit -m "Your commit message"
|
||||
```
|
||||
8. Push your changes to your forked repository:
|
||||
```shell
|
||||
git push origin <branch-name>
|
||||
```
|
||||
9. 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):
|
||||
|
||||
```shell
|
||||
just setup
|
||||
```
|
||||
|
||||
To run the application in debug mode while developing, with the ability to see logs and debug information:
|
||||
|
||||
```shell
|
||||
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:
|
||||
|
||||
```shell
|
||||
just fix
|
||||
```
|
||||
|
||||
To get a sense of the real thing and test how your patch would behave in production, run:
|
||||
|
||||
```shell
|
||||
just b release
|
||||
|
||||
# or `just br`
|
||||
# or `just build release`
|
||||
```
|
||||
|
||||
Running the tests can be done with:
|
||||
|
||||
```shell
|
||||
just test
|
||||
```
|
||||
|
||||
### Contributing a new channel
|
||||
|
||||
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
|
||||
|
||||
## Hot Topics
|
||||
|
||||
- shell integration (autocomplete, keybindings)
|
||||
- packaging for various linux package managers (dnf, ...)
|
||||
- sorting options
|
||||
- ansi parsing
|
||||
- contributing new channels
|
||||
- improving code documentation
|
Loading…
x
Reference in New Issue
Block a user